octave: libinterp/corefcn/data.cc annotate

annotate libinterp/corefcn/data.cc @ 33555:a8346c5f6997

Fix 2-output form of sort() for dim > ndims() (bug #65712) Following fixes to allow `sort (A, dim)` for dim exceeding `ndims (A)`, including the case of dim = inf, this patch does the same for the 2-output calling form of sort(). * Array-base.cc: Create `sidx` early, rework early return conditions. * data.cc: Adapt the value of `dv(dim)` when dim exceeds the size of dv. Tweak input validation conditions to trap more conditions. Add BISTs.

author	Arun Giridhar <arungiridhar@gmail.com>
date	Thu, 09 May 2024 18:13:54 -0400
parents	31bc9accbe6e
children	b2af12232f75

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 //
32632 2e484f9f1f18 maint: update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 32581 diff changeset	3 // Copyright (C) 1994-2024 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 ////////////////////////////////////////////////////////////////////////
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	25
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21723 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"
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	28 #endif
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	29
23625 b0a2367823f5 Use hypot, hypotf from C++ std library. Rik <rik@octave.org> parents: 23599 diff changeset	30 #include <cmath>
23455 73ff72d3d603 maint: Eliminate <cfloat.h> header from libinterp files Rik <rik@octave.org> parents: 23450 diff changeset	31 #include <cstddef>
73ff72d3d603 maint: Eliminate <cfloat.h> header from libinterp files Rik <rik@octave.org> parents: 23450 diff changeset	32 #include <cstdint>
10303 e4899d6320b6 data.cc: use CLOCKS_PER_SEC instead of HZ John W. Eaton <jwe@octave.org> parents: 10302 diff changeset	33 #include <ctime>
2184 dbbbb3559ee8 [project @ 1996-05-14 02:18:22 by jwe] jwe parents: 2086 diff changeset	34
23455 73ff72d3d603 maint: Eliminate <cfloat.h> header from libinterp files Rik <rik@octave.org> parents: 23450 diff changeset	35 #include <algorithm>
73ff72d3d603 maint: Eliminate <cfloat.h> header from libinterp files Rik <rik@octave.org> parents: 23450 diff changeset	36 #include <limits>
1728 42b4f904f1af [project @ 1996-01-09 11:36:01 by jwe] jwe parents: 1572 diff changeset	37 #include <string>
42b4f904f1af [project @ 1996-01-09 11:36:01 by jwe] jwe parents: 1572 diff changeset	38
2184 dbbbb3559ee8 [project @ 1996-05-14 02:18:22 by jwe] jwe parents: 2086 diff changeset	39 #include "lo-ieee.h"
23455 73ff72d3d603 maint: Eliminate <cfloat.h> header from libinterp files Rik <rik@octave.org> parents: 23450 diff changeset	40 #include "mx-base.h"
15252 fa0118cb67d9 move base64 encode and decode functionality to liboctave John W. Eaton <jwe@octave.org> parents: 15213 diff changeset	41 #include "oct-base64.h"
23455 73ff72d3d603 maint: Eliminate <cfloat.h> header from libinterp files Rik <rik@octave.org> parents: 23450 diff changeset	42 #include "oct-binmap.h"
10240 fa7b5751730c use gnulib time, sys_time, and sys_times modules John W. Eaton <jwe@octave.org> parents: 10185 diff changeset	43 #include "oct-time.h"
4153 6b96ce9f5743 [project @ 2002-11-06 20:38:49 by jwe] jwe parents: 4114 diff changeset	44 #include "quit.h"
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1742 diff changeset	45
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	46 #include "Cell.h"
23462 314d980bee93 maint: Add '#include "XXX.h"' to XXX.cc files. Rik <rik@octave.org> parents: 23455 diff changeset	47 #include "data.h"
1352 19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1315 diff changeset	48 #include "defun.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1315 diff changeset	49 #include "error.h"
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21078 diff changeset	50 #include "errwarn.h"
23599 5cb3a2bb5e1e don't use singleton for symbol_table John W. Eaton <jwe@octave.org> parents: 23592 diff changeset	51 #include "interpreter-private.h"
31730 610a85b0ff62 use interpreter::feval instead of global feval function John W. Eaton <jwe@octave.org> parents: 31707 diff changeset	52 #include "interpreter.h"
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	53 #include "oct-map.h"
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	54 #include "ov-class.h"
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	55 #include "ov-complex.h"
23462 314d980bee93 maint: Add '#include "XXX.h"' to XXX.cc files. Rik <rik@octave.org> parents: 23455 diff changeset	56 #include "ov-cx-mat.h"
314d980bee93 maint: Add '#include "XXX.h"' to XXX.cc files. Rik <rik@octave.org> parents: 23455 diff changeset	57 #include "ov-cx-sparse.h"
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	58 #include "ov-float.h"
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	59 #include "ov-flt-complex.h"
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	60 #include "ov-flt-cx-mat.h"
23462 314d980bee93 maint: Add '#include "XXX.h"' to XXX.cc files. Rik <rik@octave.org> parents: 23455 diff changeset	61 #include "ov.h"
314d980bee93 maint: Add '#include "XXX.h"' to XXX.cc files. Rik <rik@octave.org> parents: 23455 diff changeset	62 #include "ovl.h"
314d980bee93 maint: Add '#include "XXX.h"' to XXX.cc files. Rik <rik@octave.org> parents: 23455 diff changeset	63 #include "pager.h"
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	64 #include "pt-mat.h"
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	65 #include "utils.h"
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	66 #include "variables.h"
8303 b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	67 #include "xnorm.h"
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	68
31605 e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 31603 diff changeset	69 OCTAVE_BEGIN_NAMESPACE(octave)
29958 32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29955 diff changeset	70
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	71 DEFUN (all, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	72 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	73 @deftypefn {} {@var{tf} =} all (@var{x})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	74 @deftypefnx {} {@var{tf} =} all (@var{x}, @var{dim})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	75 For a vector argument, return true (logical 1) if all elements of the vector
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	76 are nonzero.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	77
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	78 For a matrix argument, return a row vector of logical ones and zeros with each
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	79 element indicating whether all of the elements of the corresponding column of
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	80 the matrix are nonzero. For example:
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	81
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	82 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	83 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	84 all ([2, 3; 1, 0])
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	85 @result{} [ 1, 0 ]
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	86 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	87 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	88
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	89 If the optional argument @var{dim} is supplied, work along dimension @var{dim}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	90 @seealso{any}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	91 @end deftypefn */)
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	92 {
20943 42319d289714 maint: Eliminate ANY_ALL macro in data.cc Rik <rik@octave.org> parents: 20940 diff changeset	93 int nargin = args.length ();
42319d289714 maint: Eliminate ANY_ALL macro in data.cc Rik <rik@octave.org> parents: 20940 diff changeset	94
42319d289714 maint: Eliminate ANY_ALL macro in data.cc Rik <rik@octave.org> parents: 20940 diff changeset	95 if (nargin < 1 \|\| nargin > 2)
42319d289714 maint: Eliminate ANY_ALL macro in data.cc Rik <rik@octave.org> parents: 20940 diff changeset	96 print_usage ();
42319d289714 maint: Eliminate ANY_ALL macro in data.cc Rik <rik@octave.org> parents: 20940 diff changeset	97
42319d289714 maint: Eliminate ANY_ALL macro in data.cc Rik <rik@octave.org> parents: 20940 diff changeset	98 int dim = (nargin == 1 ? -1
33446 5fded8395daa rename yTYPE_value functions strict_TYPE_value John W. Eaton <jwe@octave.org> parents: 33382 diff changeset	99 : args(1).strict_int_value ("all: DIM must be an integer")-1);
20943 42319d289714 maint: Eliminate ANY_ALL macro in data.cc Rik <rik@octave.org> parents: 20940 diff changeset	100
42319d289714 maint: Eliminate ANY_ALL macro in data.cc Rik <rik@octave.org> parents: 20940 diff changeset	101 if (dim < -1)
42319d289714 maint: Eliminate ANY_ALL macro in data.cc Rik <rik@octave.org> parents: 20940 diff changeset	102 error ("all: invalid dimension argument = %d", dim + 1);
42319d289714 maint: Eliminate ANY_ALL macro in data.cc Rik <rik@octave.org> parents: 20940 diff changeset	103
42319d289714 maint: Eliminate ANY_ALL macro in data.cc Rik <rik@octave.org> parents: 20940 diff changeset	104 return ovl (args(0).all (dim));
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	105 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	106
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	107 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	108 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	109 %! x = ones (3);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	110 %! x(1,1) = 0;
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	111 %! assert (all (all (rand (3) + 1) == [1, 1, 1]) == 1);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	112 %! assert (all (all (x) == [0, 1, 1]) == 1);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	113 %! assert (all (x, 1) == [0, 1, 1]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	114 %! assert (all (x, 2) == [0; 1; 1]);
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	115
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	116 %!test
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	117 %! x = ones (3, "single");
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	118 %! x(1,1) = 0;
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	119 %! assert (all (all (single (rand (3) + 1)) == [1, 1, 1]) == 1);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	120 %! assert (all (all (x) == [0, 1, 1]) == 1);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	121 %! assert (all (x, 1) == [0, 1, 1]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	122 %! assert (all (x, 2) == [0; 1; 1]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	123
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	124 %!error all ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	125 %!error all (1, 2, 3)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	126 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	127
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	128 DEFUN (any, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	129 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	130 @deftypefn {} {@var{tf} =} any (@var{x})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	131 @deftypefnx {} {@var{tf} =} any (@var{x}, @var{dim})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	132 For a vector argument, return true (logical 1) if any element of the vector
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	133 is nonzero.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	134
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	135 For a matrix argument, return a row vector of logical ones and zeros with each
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	136 element indicating whether any of the elements of the corresponding column of
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	137 the matrix are nonzero. For example:
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	138
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	139 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	140 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	141 any (eye (2, 4))
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	142 @result{} [ 1, 1, 0, 0 ]
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	143 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	144 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	145
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	146 If the optional argument @var{dim} is supplied, work along dimension @var{dim}.
31375 96f751f8392c doc: grammar check documentation ahead of 8.1 release. Rik <rik@octave.org> parents: 31369 diff changeset	147 For example:
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	148
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	149 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	150 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	151 any (eye (2, 4), 2)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	152 @result{} [ 1; 1 ]
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	153 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	154 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	155 @seealso{all}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	156 @end deftypefn */)
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	157 {
20943 42319d289714 maint: Eliminate ANY_ALL macro in data.cc Rik <rik@octave.org> parents: 20940 diff changeset	158 int nargin = args.length ();
42319d289714 maint: Eliminate ANY_ALL macro in data.cc Rik <rik@octave.org> parents: 20940 diff changeset	159
42319d289714 maint: Eliminate ANY_ALL macro in data.cc Rik <rik@octave.org> parents: 20940 diff changeset	160 if (nargin < 1 \|\| nargin > 2)
42319d289714 maint: Eliminate ANY_ALL macro in data.cc Rik <rik@octave.org> parents: 20940 diff changeset	161 print_usage ();
42319d289714 maint: Eliminate ANY_ALL macro in data.cc Rik <rik@octave.org> parents: 20940 diff changeset	162
42319d289714 maint: Eliminate ANY_ALL macro in data.cc Rik <rik@octave.org> parents: 20940 diff changeset	163 int dim = (nargin == 1 ? -1
33446 5fded8395daa rename yTYPE_value functions strict_TYPE_value John W. Eaton <jwe@octave.org> parents: 33382 diff changeset	164 : args(1).strict_int_value ("any: DIM must be an integer")-1);
20943 42319d289714 maint: Eliminate ANY_ALL macro in data.cc Rik <rik@octave.org> parents: 20940 diff changeset	165
42319d289714 maint: Eliminate ANY_ALL macro in data.cc Rik <rik@octave.org> parents: 20940 diff changeset	166 if (dim < -1)
42319d289714 maint: Eliminate ANY_ALL macro in data.cc Rik <rik@octave.org> parents: 20940 diff changeset	167 error ("any: invalid dimension argument = %d", dim + 1);
42319d289714 maint: Eliminate ANY_ALL macro in data.cc Rik <rik@octave.org> parents: 20940 diff changeset	168
42319d289714 maint: Eliminate ANY_ALL macro in data.cc Rik <rik@octave.org> parents: 20940 diff changeset	169 return ovl (args(0).any (dim));
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	170 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	171
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	172 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	173 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	174 %! x = zeros (3);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	175 %! x(3,3) = 1;
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	176 %! assert (all (any (x) == [0, 0, 1]) == 1);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	177 %! assert (all (any (ones (3)) == [1, 1, 1]) == 1);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	178 %! assert (any (x, 1) == [0, 0, 1]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	179 %! assert (any (x, 2) == [0; 0; 1]);
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	180
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	181 %!test
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	182 %! x = zeros (3, "single");
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	183 %! x(3,3) = 1;
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	184 %! assert (all (any (x) == [0, 0, 1]) == 1);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	185 %! assert (all (any (ones (3, "single")) == [1, 1, 1]) == 1);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	186 %! assert (any (x, 1) == [0, 0, 1]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	187 %! assert (any (x, 2) == [0; 0; 1]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	188
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	189 %!error any ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	190 %!error any (1, 2, 3)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	191 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	192
649 1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	193 // These mapping functions may also be useful in other places, eh?
1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	194
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	195 DEFUN (atan2, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	196 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	197 @deftypefn {} {@var{angle} =} atan2 (@var{y}, @var{x})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	198 Compute atan (@var{y} / @var{x}) for corresponding elements of @var{y} and
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	199 @var{x}.
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	200
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	201 @var{y} and @var{x} must match in size and orientation. The signs of elements
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	202 of @var{y} and @var{x} are used to determine the quadrants of each resulting
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	203 value.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	204
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	205 This function is equivalent to @code{arg (complex (@var{x}, @var{y}))}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	206 @seealso{tan, tand, tanh, atanh}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	207 @end deftypefn */)
649 1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	208 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	209 if (args.length () != 2)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	210 print_usage ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	211
4233 ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe] jwe parents: 4176 diff changeset	212 octave_value retval;
649 1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	213
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23585 diff changeset	214 if (! args(0).isnumeric ())
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21078 diff changeset	215 err_wrong_type_arg ("atan2", args(0));
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	216
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23585 diff changeset	217 if (! args(1).isnumeric ())
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21078 diff changeset	218 err_wrong_type_arg ("atan2", args(1));
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	219
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	220 if (args(0).iscomplex () \|\| args(1).iscomplex ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	221 error ("atan2: not defined for complex numbers");
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	222
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	223 if (args(0).is_single_type () \|\| args(1).is_single_type ())
649 1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	224 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	225 if (args(0).is_scalar_type () && args(1).is_scalar_type ())
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	226 retval = atan2f (args(0).float_value (), args(1).float_value ());
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	227 else
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	228 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	229 FloatNDArray a0 = args(0).float_array_value ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	230 FloatNDArray a1 = args(1).float_array_value ();
24088 0160a3199b2d avoid warnings from GCC about ABI change with exception specifications John W. Eaton <jwe@octave.org> parents: 23803 diff changeset	231 retval = binmap<float> (a0, a1, std::atan2, "atan2");
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	232 }
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	233 }
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	234 else
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	235 {
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	236 if (args(0).is_scalar_type () && args(1).is_scalar_type ())
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	237 retval = atan2 (args(0).scalar_value (), args(1).scalar_value ());
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	238 else if (args(0).issparse ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	239 {
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	240 SparseMatrix m0 = args(0).sparse_matrix_value ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	241 SparseMatrix m1 = args(1).sparse_matrix_value ();
24088 0160a3199b2d avoid warnings from GCC about ABI change with exception specifications John W. Eaton <jwe@octave.org> parents: 23803 diff changeset	242 retval = binmap<double> (m0, m1, std::atan2, "atan2");
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	243 }
7494 bd2bd04e68ca Treat integer types for mod/rem correctly David Bateman <dbateman@free.fr> parents: 7433 diff changeset	244 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	245 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	246 NDArray a0 = args(0).array_value ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	247 NDArray a1 = args(1).array_value ();
24088 0160a3199b2d avoid warnings from GCC about ABI change with exception specifications John W. Eaton <jwe@octave.org> parents: 23803 diff changeset	248 retval = binmap<double> (a0, a1, std::atan2, "atan2");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	249 }
649 1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	250 }
1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	251
1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	252 return retval;
1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	253 }
1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	254
7506 798b0a00e80c atan2, fmod: accept N-d arrays John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	255 /*
7741 72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	256 %!assert (size (atan2 (zeros (0, 2), zeros (0, 2))), [0, 2])
72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	257 %!assert (size (atan2 (rand (2, 3, 4), zeros (2, 3, 4))), [2, 3, 4])
72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	258 %!assert (size (atan2 (rand (2, 3, 4), 1)), [2, 3, 4])
72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	259 %!assert (size (atan2 (1, rand (2, 3, 4))), [2, 3, 4])
72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	260 %!assert (size (atan2 (1, 2)), [1, 1])
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	261
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	262 %!test
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	263 %! rt2 = sqrt (2);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	264 %! rt3 = sqrt (3);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	265 %! v = [0, pi/6, pi/4, pi/3, -pi/3, -pi/4, -pi/6, 0];
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	266 %! y = [0, rt3, 1, rt3, -rt3, -1, -rt3, 0];
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	267 %! x = [1, 3, 1, 1, 1, 1, 3, 1];
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	268 %! assert (atan2 (y, x), v, sqrt (eps));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	269
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	270 %!test
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	271 %! rt2 = sqrt (2);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	272 %! rt3 = sqrt (3);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	273 %! v = single ([0, pi/6, pi/4, pi/3, -pi/3, -pi/4, -pi/6, 0]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	274 %! y = single ([0, rt3, 1, rt3, -rt3, -1, -rt3, 0]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	275 %! x = single ([1, 3, 1, 1, 1, 1, 3, 1]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	276 %! assert (atan2 (y, x), v, sqrt (eps ("single")));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	277
18789 dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	278 ## Test sparse implementations
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	279 %!shared xs
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	280 %! xs = sparse (0:3);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	281 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	282 %! y = atan2 (1, xs);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	283 %! assert (issparse (y), false);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	284 %! assert (nnz (y), 4);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	285 %! assert (y, atan2 (1, 0:3));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	286 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	287 %! y = atan2 (0, xs);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	288 %! assert (issparse (y), false);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	289 %! assert (nnz (y), 0);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	290 %! assert (y, zeros (1,4));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	291 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	292 %! y = atan2 (xs, 1);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	293 %! assert (issparse (y));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	294 %! assert (nnz (y), 3);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	295 %! assert (y, sparse (atan2 (0:3, 1)));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	296 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	297 %! y = atan2 (xs, 0);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	298 %! assert (issparse (y));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	299 %! assert (nnz (y), 3);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	300 %! assert (y, sparse (atan2 (0:3, 0)));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	301 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	302 %! y = atan2 (xs, sparse (ones (1, 4)));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	303 %! assert (issparse (y));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	304 %! assert (nnz (y), 3);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	305 %! assert (y, sparse (atan2 (0:3, ones (1,4))));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	306 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	307 %! y = atan2 (xs, sparse (zeros (1,4)));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	308 %! assert (issparse (y));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	309 %! assert (nnz (y), 3);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	310 %! assert (y, sparse (atan2 (0:3, zeros (1,4))));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	311
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	312 %!error atan2 ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	313 %!error atan2 (1, 2, 3)
7506 798b0a00e80c atan2, fmod: accept N-d arrays John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	314 */
798b0a00e80c atan2, fmod: accept N-d arrays John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	315
10538 26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	316 static octave_value
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	317 do_hypot (const octave_value& x, const octave_value& y)
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	318 {
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	319 octave_value retval;
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	320
18100 6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	321 octave_value arg0 = x;
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	322 octave_value arg1 = y;
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23585 diff changeset	323 if (! arg0.isnumeric ())
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21078 diff changeset	324 err_wrong_type_arg ("hypot", arg0);
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23585 diff changeset	325 if (! arg1.isnumeric ())
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21078 diff changeset	326 err_wrong_type_arg ("hypot", arg1);
21118 3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	327
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	328 if (arg0.iscomplex ())
21118 3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	329 arg0 = arg0.abs ();
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	330 if (arg1.iscomplex ())
21118 3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	331 arg1 = arg1.abs ();
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	332
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	333 if (arg0.is_single_type () \|\| arg1.is_single_type ())
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	334 {
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	335 if (arg0.is_scalar_type () && arg1.is_scalar_type ())
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	336 retval = hypotf (arg0.float_value (), arg1.float_value ());
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	337 else
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	338 {
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	339 FloatNDArray a0 = arg0.float_array_value ();
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	340 FloatNDArray a1 = arg1.float_array_value ();
24088 0160a3199b2d avoid warnings from GCC about ABI change with exception specifications John W. Eaton <jwe@octave.org> parents: 23803 diff changeset	341 retval = binmap<float> (a0, a1, std::hypot, "hypot");
21118 3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	342 }
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	343 }
10538 26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	344 else
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	345 {
21118 3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	346 if (arg0.is_scalar_type () && arg1.is_scalar_type ())
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	347 retval = hypot (arg0.scalar_value (), arg1.scalar_value ());
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	348 else if (arg0.issparse () \|\| arg1.issparse ())
10538 26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	349 {
21118 3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	350 SparseMatrix m0 = arg0.sparse_matrix_value ();
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	351 SparseMatrix m1 = arg1.sparse_matrix_value ();
23625 b0a2367823f5 Use hypot, hypotf from C++ std library. Rik <rik@octave.org> parents: 23599 diff changeset	352 retval = binmap<double> (m0, m1, std::hypot, "hypot");
10538 26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	353 }
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	354 else
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	355 {
21118 3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	356 NDArray a0 = arg0.array_value ();
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	357 NDArray a1 = arg1.array_value ();
23625 b0a2367823f5 Use hypot, hypotf from C++ std library. Rik <rik@octave.org> parents: 23599 diff changeset	358 retval = binmap<double> (a0, a1, std::hypot, "hypot");
10538 26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	359 }
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	360 }
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	361
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	362 return retval;
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	363 }
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	364
7631 b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	365 DEFUN (hypot, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	366 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	367 @deftypefn {} {@var{h} =} hypot (@var{x}, @var{y})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	368 @deftypefnx {} {@var{h} =} hypot (@var{x}, @var{y}, @var{z}, @dots{})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	369 Compute the element-by-element square root of the sum of the squares of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	370 @var{x} and @var{y}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	371
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	372 This is equivalent to
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	373 @code{sqrt (@var{x}.^2 + @var{y}.^2)}, but is calculated in a manner that
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	374 avoids overflows for large values of @var{x} or @var{y}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	375
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	376 @code{hypot} can also be called with more than 2 arguments; in this case,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	377 the arguments are accumulated from left to right:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	378
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	379 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	380 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	381 hypot (hypot (@var{x}, @var{y}), @var{z})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	382 hypot (hypot (hypot (@var{x}, @var{y}), @var{z}), @var{w}), etc.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	383 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	384 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	385 @end deftypefn */)
7631 b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	386 {
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	387 int nargin = args.length ();
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	388
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	389 if (nargin < 2)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	390 print_usage ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	391
7631 b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	392 octave_value retval;
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	393
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	394 if (nargin == 2)
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	395 retval = do_hypot (args(0), args(1));
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	396 else
10538 26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	397 {
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	398 retval = args(0);
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	399
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	400 for (int i = 1; i < nargin; i++)
10538 26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	401 retval = do_hypot (retval, args(i));
7631 b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	402 }
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	403
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	404 return retval;
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	405 }
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	406
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	407 /*
7741 72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	408 %!assert (size (hypot (zeros (0, 2), zeros (0, 2))), [0, 2])
72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	409 %!assert (size (hypot (rand (2, 3, 4), zeros (2, 3, 4))), [2, 3, 4])
72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	410 %!assert (size (hypot (rand (2, 3, 4), 1)), [2, 3, 4])
72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	411 %!assert (size (hypot (1, rand (2, 3, 4))), [2, 3, 4])
72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	412 %!assert (size (hypot (1, 2)), [1, 1])
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	413 %!assert (hypot (1:10, 1:10), sqrt (2) * [1:10], 16*eps)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	414 %!assert (hypot (single (1:10), single (1:10)), single (sqrt (2) * [1:10]))
18789 dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	415
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	416 ## Test sparse implementations
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	417 %!shared xs
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	418 %! xs = sparse (0:3);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	419 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	420 %! y = hypot (1, xs);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	421 %! assert (nnz (y), 4);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	422 %! assert (y, sparse (hypot (1, 0:3)));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	423 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	424 %! y = hypot (0, xs);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	425 %! assert (nnz (y), 3);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	426 %! assert (y, xs);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	427 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	428 %! y = hypot (xs, 1);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	429 %! assert (nnz (y), 4);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	430 %! assert (y, sparse (hypot (0:3, 1)));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	431 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	432 %! y = hypot (xs, 0);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	433 %! assert (nnz (y), 3);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	434 %! assert (y, xs);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	435 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	436 %! y = hypot (sparse ([0 0]), sparse ([0 1]));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	437 %! assert (nnz (y), 1);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	438 %! assert (y, sparse ([0 1]));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	439 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	440 %! y = hypot (sparse ([0 1]), sparse ([0 0]));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	441 %! assert (nnz (y), 1);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	442 %! assert (y, sparse ([0 1]));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	443
7631 b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	444 */
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	445
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21129 diff changeset	446 template <typename T, typename ET>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	447 void
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	448 map_2_xlog2 (const Array<T>& x, Array<T>& f, Array<ET>& e)
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	449 {
32513 1de97b475564 maint: Add space " " between C++ cast and argument. Markus Mützel <markus.muetzel@gmx.de> parents: 32060 diff changeset	450 f = Array<T> (x.dims ());
1de97b475564 maint: Add space " " between C++ cast and argument. Markus Mützel <markus.muetzel@gmx.de> parents: 32060 diff changeset	451 e = Array<ET> (x.dims ());
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	452 for (octave_idx_type i = 0; i < x.numel (); i++)
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	453 {
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	454 int exp;
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	455 f.xelem (i) = math::log2 (x(i), exp);
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	456 e.xelem (i) = exp;
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	457 }
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	458 }
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	459
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	460 DEFUN (log2, args, nargout,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	461 doc: /* -- texinfo --
29817 ba571657651a Improve documentation for log2 function (bug #60817). Rik <rik@octave.org> parents: 29654 diff changeset	462 @deftypefn {} {@var{y} =} log2 (@var{x})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	463 @deftypefnx {} {[@var{f}, @var{e}] =} log2 (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	464 Compute the base-2 logarithm of each element of @var{x}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	465
29817 ba571657651a Improve documentation for log2 function (bug #60817). Rik <rik@octave.org> parents: 29654 diff changeset	466 If called with one output, compute the base-2 logarithm such that
ba571657651a Improve documentation for log2 function (bug #60817). Rik <rik@octave.org> parents: 29654 diff changeset	467 @tex
ba571657651a Improve documentation for log2 function (bug #60817). Rik <rik@octave.org> parents: 29654 diff changeset	468 $2^y = x$.
ba571657651a Improve documentation for log2 function (bug #60817). Rik <rik@octave.org> parents: 29654 diff changeset	469 @end tex
ba571657651a Improve documentation for log2 function (bug #60817). Rik <rik@octave.org> parents: 29654 diff changeset	470 @ifnottex
ba571657651a Improve documentation for log2 function (bug #60817). Rik <rik@octave.org> parents: 29654 diff changeset	471 @code{2^@var{y} = @var{x}}.
ba571657651a Improve documentation for log2 function (bug #60817). Rik <rik@octave.org> parents: 29654 diff changeset	472 @end ifnottex
ba571657651a Improve documentation for log2 function (bug #60817). Rik <rik@octave.org> parents: 29654 diff changeset	473
ba571657651a Improve documentation for log2 function (bug #60817). Rik <rik@octave.org> parents: 29654 diff changeset	474 If called with two output arguments, split @var{x} into binary mantissa
ba571657651a Improve documentation for log2 function (bug #60817). Rik <rik@octave.org> parents: 29654 diff changeset	475 (@var{f}) and exponent (@var{e}) such that
ba571657651a Improve documentation for log2 function (bug #60817). Rik <rik@octave.org> parents: 29654 diff changeset	476 @tex
ba571657651a Improve documentation for log2 function (bug #60817). Rik <rik@octave.org> parents: 29654 diff changeset	477 $x = f \cdot 2^e$
ba571657651a Improve documentation for log2 function (bug #60817). Rik <rik@octave.org> parents: 29654 diff changeset	478 @end tex
ba571657651a Improve documentation for log2 function (bug #60817). Rik <rik@octave.org> parents: 29654 diff changeset	479 @ifnottex
ba571657651a Improve documentation for log2 function (bug #60817). Rik <rik@octave.org> parents: 29654 diff changeset	480 @code{@var{x} = @var{f} * 2^@var{e}}
ba571657651a Improve documentation for log2 function (bug #60817). Rik <rik@octave.org> parents: 29654 diff changeset	481 @end ifnottex
ba571657651a Improve documentation for log2 function (bug #60817). Rik <rik@octave.org> parents: 29654 diff changeset	482 where
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	483 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	484 ${1 \over 2} \le \left\| f \right\| < 1$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	485 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	486 @ifnottex
29817 ba571657651a Improve documentation for log2 function (bug #60817). Rik <rik@octave.org> parents: 29654 diff changeset	487 @w{@code{1/2 <= abs (@var{f}) < 1}}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	488 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	489 and @var{e} is an integer. If
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	490 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	491 $x = 0$, $f = e = 0$.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	492 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	493 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	494 @w{@code{x = 0}}, @w{@code{f = e = 0}}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	495 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	496 @seealso{pow2, log, log10, exp}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	497 @end deftypefn */)
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	498 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	499 if (args.length () != 1)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	500 print_usage ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	501
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	502 octave_value_list retval;
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	503
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	504 if (nargout < 2)
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20853 diff changeset	505 retval = ovl (args(0).log2 ());
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	506 else if (args(0).is_single_type ())
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	507 {
23582 0cc2011d800e maint: Deprecate is_real_type and replace with isreal. Rik <rik@octave.org> parents: 23581 diff changeset	508 if (args(0).isreal ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	509 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	510 FloatNDArray f;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	511 FloatNDArray x = args(0).float_array_value ();
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	512 // FIXME: should E be an int value?
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	513 FloatMatrix e;
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	514 map_2_xlog2 (x, f, e);
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20853 diff changeset	515 retval = ovl (f, e);
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	516 }
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	517 else if (args(0).iscomplex ())
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	518 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	519 FloatComplexNDArray f;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	520 FloatComplexNDArray x = args(0).float_complex_array_value ();
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	521 // FIXME: should E be an int value?
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	522 FloatNDArray e;
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	523 map_2_xlog2 (x, f, e);
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20853 diff changeset	524 retval = ovl (f, e);
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	525 }
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	526 }
23582 0cc2011d800e maint: Deprecate is_real_type and replace with isreal. Rik <rik@octave.org> parents: 23581 diff changeset	527 else if (args(0).isreal ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	528 {
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	529 NDArray f;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	530 NDArray x = args(0).array_value ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	531 // FIXME: should E be an int value?
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	532 Matrix e;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	533 map_2_xlog2 (x, f, e);
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20853 diff changeset	534 retval = ovl (f, e);
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	535 }
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	536 else if (args(0).iscomplex ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	537 {
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	538 ComplexNDArray f;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	539 ComplexNDArray x = args(0).complex_array_value ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	540 // FIXME: should E be an int value?
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	541 NDArray e;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	542 map_2_xlog2 (x, f, e);
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20853 diff changeset	543 retval = ovl (f, e);
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	544 }
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	545 else
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21078 diff changeset	546 err_wrong_type_arg ("log2", args(0));
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	547
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	548 return retval;
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	549 }
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	550
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	551 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	552 %!assert (log2 ([1/4, 1/2, 1, 2, 4]), [-2, -1, 0, 1, 2])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	553 %!assert (log2 (Inf), Inf)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	554 %!assert (isnan (log2 (NaN)))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	555 %!assert (log2 (4i), 2 + log2 (1i))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	556 %!assert (log2 (complex (0,Inf)), Inf + log2 (i))
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	557
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	558 %!test
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	559 %! [f, e] = log2 ([0,-1; 2,-4; Inf,-Inf]);
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	560 %! assert (f, [0,-0.5; 0.5,-0.5; Inf,-Inf]);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	561 %! assert (e(1:2,:), [0,1;2,3]);
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	562
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	563 %!test
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	564 %! [f, e] = log2 (complex (zeros (3, 2), [0,-1; 2,-4; Inf,-Inf]));
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	565 %! assert (f, complex (zeros (3, 2), [0,-0.5; 0.5,-0.5; Inf,-Inf]));
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	566 %! assert (e(1:2,:), [0,1; 2,3]);
18851 9d185537e5d1 * data.cc: New test for log2 (bug #42583). John W. Eaton <jwe@octave.org> parents: 18809 diff changeset	567
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	568 %!assert <*42583> (all (log2 (pow2 (-1074:1023)) == -1074:1023))
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	569 */
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	570
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	571 DEFUN (rem, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	572 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	573 @deftypefn {} {@var{r} =} rem (@var{x}, @var{y})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	574 Return the remainder of the division @code{@var{x} / @var{y}}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	575
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	576 The remainder is computed using the expression
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	577
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	578 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	579 x - y .* fix (x ./ y)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	580 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	581
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	582 An error message is printed if the dimensions of the arguments do not agree,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	583 or if either argument is complex.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	584
26292 d00577d95369 doc: Add warning note about integers exceeding flintmax to mod, rem (bug #55238). Rik <rik@octave.org> parents: 26199 diff changeset	585 Programming Notes: When calculating with floating point numbers (double,
d00577d95369 doc: Add warning note about integers exceeding flintmax to mod, rem (bug #55238). Rik <rik@octave.org> parents: 26199 diff changeset	586 single), values within a few eps of an integer will be rounded to that
d00577d95369 doc: Add warning note about integers exceeding flintmax to mod, rem (bug #55238). Rik <rik@octave.org> parents: 26199 diff changeset	587 integer before computation for compatibility with @sc{matlab}. Any floating
d00577d95369 doc: Add warning note about integers exceeding flintmax to mod, rem (bug #55238). Rik <rik@octave.org> parents: 26199 diff changeset	588 point integers greater than @code{flintmax} (2^53 for double) will not compute
d00577d95369 doc: Add warning note about integers exceeding flintmax to mod, rem (bug #55238). Rik <rik@octave.org> parents: 26199 diff changeset	589 correctly. For larger integer values convert the input to @code{uint64} before
d00577d95369 doc: Add warning note about integers exceeding flintmax to mod, rem (bug #55238). Rik <rik@octave.org> parents: 26199 diff changeset	590 calling this function.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	591
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	592 By convention,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	593
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	594 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	595 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	596 rem (@var{x}, 0) = NaN if @var{x} is a floating point variable
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	597 rem (@var{x}, 0) = 0 if @var{x} is an integer variable
26292 d00577d95369 doc: Add warning note about integers exceeding flintmax to mod, rem (bug #55238). Rik <rik@octave.org> parents: 26199 diff changeset	598 rem (@var{x}, @var{y}) returns a value with the signbit from @var{x}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	599 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	600 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	601
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	602 For the opposite conventions see the @code{mod} function. In general,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	603 @code{rem} is best when computing the remainder after division of two
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	604 @emph{positive} numbers. For negative numbers, or when the values are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	605 periodic, @code{mod} is a better choice.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	606 @seealso{mod}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	607 @end deftypefn */)
4311 a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	608 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	609 if (args.length () != 2)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	610 print_usage ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	611
4311 a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	612 octave_value retval;
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	613
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23585 diff changeset	614 if (! args(0).isnumeric ())
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21078 diff changeset	615 err_wrong_type_arg ("rem", args(0));
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	616
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23585 diff changeset	617 if (! args(1).isnumeric ())
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21078 diff changeset	618 err_wrong_type_arg ("rem", args(1));
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	619
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	620 if (args(0).iscomplex () \|\| args(1).iscomplex ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	621 error ("rem: not defined for complex numbers");
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	622
23580 2230f9e10fb3 maint: Deprecate is_integer_type and replace with isinteger. Rik <rik@octave.org> parents: 23579 diff changeset	623 if (args(0).isinteger () \|\| args(1).isinteger ())
4311 a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	624 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	625 builtin_type_t btyp0 = args(0).builtin_type ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	626 builtin_type_t btyp1 = args(1).builtin_type ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	627 if (btyp0 == btyp_double \|\| btyp0 == btyp_float)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	628 btyp0 = btyp1;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	629 if (btyp1 == btyp_double \|\| btyp1 == btyp_float)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	630 btyp1 = btyp0;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	631
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	632 if (btyp0 != btyp1)
26107 05dfcb24ef12 Supply missing arguments to variable length printf functions (bug #55046). Rik <rik@octave.org>* parents: 26046 diff changeset	633 error ("rem: cannot combine %s and %s",
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	634 args(0).class_name ().c_str (),
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	635 args(1).class_name ().c_str ());
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	636
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	637 switch (btyp0)
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	638 {
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	639 #define MAKE_INT_BRANCH(X) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	640 case btyp_ ## X: \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	641 { \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	642 X##NDArray a0 = args(0).X##_array_value (); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	643 X##NDArray a1 = args(1).X##_array_value (); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	644 retval = binmap<octave_##X,octave_##X,octave_##X> (a0, a1, rem, "rem"); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	645 } \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	646 break
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	647
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	648 MAKE_INT_BRANCH (int8);
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	649 MAKE_INT_BRANCH (int16);
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	650 MAKE_INT_BRANCH (int32);
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	651 MAKE_INT_BRANCH (int64);
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	652 MAKE_INT_BRANCH (uint8);
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	653 MAKE_INT_BRANCH (uint16);
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	654 MAKE_INT_BRANCH (uint32);
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	655 MAKE_INT_BRANCH (uint64);
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	656
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	657 #undef MAKE_INT_BRANCH
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	658
33344 3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	659 case btyp_double:
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	660 case btyp_float:
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	661 case btyp_complex:
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	662 case btyp_float_complex:
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	663 case btyp_bool:
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	664 case btyp_char:
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	665 case btyp_struct:
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	666 case btyp_cell:
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	667 case btyp_func_handle:
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	668 case btyp_unknown:
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	669 error ("rem: unexpected: found %s instead of integer - please report this bug", btyp_class_name[btyp0].c_str ());
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	670 break;
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	671
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	672 // We should have handled all possible enum values above.
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	673 // Rely on compiler diagnostics to warn if we haven't. For
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	674 // example, GCC's -Wswitch option, enabled by -Wall, will
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	675 // provide a warning.
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	676 }
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	677 }
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	678 else if (args(0).is_single_type () \|\| args(1).is_single_type ())
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	679 {
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	680 if (args(0).is_scalar_type () && args(1).is_scalar_type ())
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	681 retval = math::rem (args(0).float_value (), args(1).float_value ());
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	682 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	683 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	684 FloatNDArray a0 = args(0).float_array_value ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	685 FloatNDArray a1 = args(1).float_array_value ();
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	686 retval = binmap<float> (a0, a1, math::rem<float>, "rem");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	687 }
4311 a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	688 }
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	689 else
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	690 {
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	691 if (args(0).is_scalar_type () && args(1).is_scalar_type ())
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	692 retval = math::rem (args(0).scalar_value (), args(1).scalar_value ());
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	693 else if (args(0).issparse () \|\| args(1).issparse ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	694 {
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	695 SparseMatrix m0 = args(0).sparse_matrix_value ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	696 SparseMatrix m1 = args(1).sparse_matrix_value ();
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	697 retval = binmap<double> (m0, m1, math::rem<double>, "rem");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	698 }
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	699 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	700 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	701 NDArray a0 = args(0).array_value ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	702 NDArray a1 = args(1).array_value ();
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	703 retval = binmap<double> (a0, a1, math::rem<double>, "rem");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	704 }
4311 a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	705 }
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	706
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	707 return retval;
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	708 }
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	709
7506 798b0a00e80c atan2, fmod: accept N-d arrays John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	710 /*
19118 9c5a17d5fc19 Deprecate fmod function. Rik <rik@octave.org> parents: 19079 diff changeset	711 %!assert (size (rem (zeros (0, 2), zeros (0, 2))), [0, 2])
9c5a17d5fc19 Deprecate fmod function. Rik <rik@octave.org> parents: 19079 diff changeset	712 %!assert (size (rem (rand (2, 3, 4), zeros (2, 3, 4))), [2, 3, 4])
9c5a17d5fc19 Deprecate fmod function. Rik <rik@octave.org> parents: 19079 diff changeset	713 %!assert (size (rem (rand (2, 3, 4), 1)), [2, 3, 4])
9c5a17d5fc19 Deprecate fmod function. Rik <rik@octave.org> parents: 19079 diff changeset	714 %!assert (size (rem (1, rand (2, 3, 4))), [2, 3, 4])
9c5a17d5fc19 Deprecate fmod function. Rik <rik@octave.org> parents: 19079 diff changeset	715 %!assert (size (rem (1, 2)), [1, 1])
18789 dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	716
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	717 %!assert (rem ([1, 2, 3; -1, -2, -3], 2), [1, 0, 1; -1, 0, -1])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	718 %!assert (rem ([1, 2, 3; -1, -2, -3], 2 * ones (2, 3)),[1, 0, 1; -1, 0, -1])
21317 a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions. Rik <rik@octave.org> parents: 21301 diff changeset	719 %!assert (rem ([0, 1, 2], [0, 0, 1]), [NaN, NaN, 0])
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	720 %!assert (rem (uint8 ([1, 2, 3; -1, -2, -3]), uint8 (2)),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	721 %! uint8 ([1, 0, 1; -1, 0, -1]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	722 %!assert (uint8 (rem ([1, 2, 3; -1, -2, -3], 2 * ones (2, 3))),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	723 %! uint8 ([1, 0, 1; -1, 0, -1]))
21317 a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions. Rik <rik@octave.org> parents: 21301 diff changeset	724 %!assert (rem (uint8 ([0, 1, 2]), [0, 0, 1]), uint8 ([0, 0, 0]))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	725
18789 dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	726 ## Test sparse implementations
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	727 %!shared xs
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	728 %! xs = sparse (0:3);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	729 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	730 %! y = rem (11, xs);
20374 0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20232 diff changeset	731 %! assert (isnan (y(1)));
18789 dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	732 %! assert (y, sparse (rem (11, 0:3)));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	733 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	734 %! y = rem (0, xs);
20374 0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20232 diff changeset	735 %! assert (nnz (y), 1);
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20232 diff changeset	736 %! assert (y, sparse ([NaN 0 0 0]));
18789 dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	737 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	738 %! y = rem (xs, 2);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	739 %! assert (nnz (y), 2);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	740 %! assert (y, sparse (rem (0:3, 2)));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	741 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	742 %! y = rem (xs, 1);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	743 %! assert (nnz (y), 0);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	744 %! assert (y, sparse (rem (0:3, 1)));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	745 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	746 %! y = rem (sparse ([11 11 11 11]), xs);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	747 %! assert (nnz (y), 3);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	748 %! assert (y, sparse (rem (11, 0:3)));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	749 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	750 %! y = rem (sparse ([0 0 0 0]), xs);
20374 0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20232 diff changeset	751 %! assert (nnz (y), 1);
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20232 diff changeset	752 %! assert (y, sparse ([NaN 0 0 0]));
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20232 diff changeset	753
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	754 %!assert <*45587> (signbit (rem (-0, 1)))
1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	755 %!assert <*45587> (! signbit (rem (0, 1)))
1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	756
1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	757 %!assert <*42627> (rem (0.94, 0.01), 0.0)
18789 dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18775 diff changeset	758
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	759 %!error rem (uint (8), int8 (5))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	760 %!error rem (uint8 ([1, 2]), uint8 ([3, 4, 5]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	761 %!error rem ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	762 %!error rem (1, 2, 3)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	763 %!error rem ([1, 2], [3, 4, 5])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	764 %!error rem (i, 1)
7506 798b0a00e80c atan2, fmod: accept N-d arrays John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	765 */
798b0a00e80c atan2, fmod: accept N-d arrays John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	766
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	767 DEFUN (mod, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	768 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	769 @deftypefn {} {@var{m} =} mod (@var{x}, @var{y})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	770 Compute the modulo of @var{x} and @var{y}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	771
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	772 Conceptually this is given by
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	773
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	774 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	775 x - y .* floor (x ./ y)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	776 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	777
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	778 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	779 and is written such that the correct modulus is returned for integer types.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	780 This function handles negative values correctly. That is,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	781 @w{@code{mod (-1, 3)}} is 2, not -1, as @w{@code{rem (-1, 3)}} returns.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	782
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	783 An error results if the dimensions of the arguments do not agree, or if
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	784 either of the arguments is complex.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	785
26292 d00577d95369 doc: Add warning note about integers exceeding flintmax to mod, rem (bug #55238). Rik <rik@octave.org> parents: 26199 diff changeset	786 Programming Notes: When calculating with floating point numbers (double,
d00577d95369 doc: Add warning note about integers exceeding flintmax to mod, rem (bug #55238). Rik <rik@octave.org> parents: 26199 diff changeset	787 single), values within a few eps of an integer will be rounded to that
d00577d95369 doc: Add warning note about integers exceeding flintmax to mod, rem (bug #55238). Rik <rik@octave.org> parents: 26199 diff changeset	788 integer before computation for compatibility with @sc{matlab}. Any floating
d00577d95369 doc: Add warning note about integers exceeding flintmax to mod, rem (bug #55238). Rik <rik@octave.org> parents: 26199 diff changeset	789 point integers greater than @code{flintmax} (2^53 for double) will not compute
d00577d95369 doc: Add warning note about integers exceeding flintmax to mod, rem (bug #55238). Rik <rik@octave.org> parents: 26199 diff changeset	790 correctly. For larger integer values convert the input to @code{uint64} before
d00577d95369 doc: Add warning note about integers exceeding flintmax to mod, rem (bug #55238). Rik <rik@octave.org> parents: 26199 diff changeset	791 calling this function.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	792
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	793 By convention,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	794
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	795 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	796 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	797 mod (@var{x}, 0) = @var{x}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	798 mod (@var{x}, @var{y}) returns a value with the signbit from @var{y}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	799 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	800 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	801
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	802 For the opposite conventions see the @code{rem} function. In general,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	803 @code{mod} is a better choice than @code{rem} when any of the inputs are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	804 negative numbers or when the values are periodic.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	805 @seealso{rem}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	806 @end deftypefn */)
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	807 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	808 if (args.length () != 2)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	809 print_usage ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	810
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	811 octave_value retval;
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	812
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23585 diff changeset	813 if (! args(0).isnumeric ())
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21078 diff changeset	814 err_wrong_type_arg ("mod", args(0));
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	815
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23585 diff changeset	816 if (! args(1).isnumeric ())
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21078 diff changeset	817 err_wrong_type_arg ("mod", args(1));
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	818
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	819 if (args(0).iscomplex () \|\| args(1).iscomplex ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	820 error ("mod: not defined for complex numbers");
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	821
23580 2230f9e10fb3 maint: Deprecate is_integer_type and replace with isinteger. Rik <rik@octave.org> parents: 23579 diff changeset	822 if (args(0).isinteger () \|\| args(1).isinteger ())
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	823 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	824 builtin_type_t btyp0 = args(0).builtin_type ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	825 builtin_type_t btyp1 = args(1).builtin_type ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	826 if (btyp0 == btyp_double \|\| btyp0 == btyp_float)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	827 btyp0 = btyp1;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	828 if (btyp1 == btyp_double \|\| btyp1 == btyp_float)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	829 btyp1 = btyp0;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	830
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	831 if (btyp0 != btyp1)
26107 05dfcb24ef12 Supply missing arguments to variable length printf functions (bug #55046). Rik <rik@octave.org>* parents: 26046 diff changeset	832 error ("mod: cannot combine %s and %s",
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	833 args(0).class_name ().c_str (),
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	834 args(1).class_name ().c_str ());
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	835
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	836 switch (btyp0)
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	837 {
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	838 #define MAKE_INT_BRANCH(X) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	839 case btyp_ ## X: \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	840 { \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	841 X##NDArray a0 = args(0).X##_array_value (); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	842 X##NDArray a1 = args(1).X##_array_value (); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	843 retval = binmap<octave_##X,octave_##X,octave_##X> (a0, a1, mod, "mod"); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	844 } \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	845 break
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	846
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	847 MAKE_INT_BRANCH (int8);
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	848 MAKE_INT_BRANCH (int16);
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	849 MAKE_INT_BRANCH (int32);
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	850 MAKE_INT_BRANCH (int64);
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	851 MAKE_INT_BRANCH (uint8);
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	852 MAKE_INT_BRANCH (uint16);
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	853 MAKE_INT_BRANCH (uint32);
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	854 MAKE_INT_BRANCH (uint64);
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	855
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	856 #undef MAKE_INT_BRANCH
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	857
33344 3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	858 case btyp_double:
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	859 case btyp_float:
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	860 case btyp_complex:
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	861 case btyp_float_complex:
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	862 case btyp_bool:
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	863 case btyp_char:
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	864 case btyp_struct:
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	865 case btyp_cell:
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	866 case btyp_func_handle:
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	867 case btyp_unknown:
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	868 error ("mod: unexpected: found %s instead of integer - please report this bug", btyp_class_name[btyp0].c_str ());
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	869 break;
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	870
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	871 // We should have handled all possible enum values above.
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	872 // Rely on compiler diagnostics to warn if we haven't. For
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	873 // example, GCC's -Wswitch option, enabled by -Wall, will
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases John W. Eaton <jwe@octave.org> parents: 33271 diff changeset	874 // provide a warning.
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	875 }
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	876 }
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	877 else if (args(0).is_single_type () \|\| args(1).is_single_type ())
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	878 {
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	879 if (args(0).is_scalar_type () && args(1).is_scalar_type ())
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	880 retval = math::mod (args(0).float_value (), args(1).float_value ());
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	881 else
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	882 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	883 FloatNDArray a0 = args(0).float_array_value ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	884 FloatNDArray a1 = args(1).float_array_value ();
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	885 retval = binmap<float> (a0, a1, math::mod<float>, "mod");
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	886 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	887 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	888 else
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	889 {
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	890 if (args(0).is_scalar_type () && args(1).is_scalar_type ())
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	891 retval = math::mod (args(0).scalar_value (), args(1).scalar_value ());
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	892 else if (args(0).issparse () \|\| args(1).issparse ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	893 {
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	894 SparseMatrix m0 = args(0).sparse_matrix_value ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	895 SparseMatrix m1 = args(1).sparse_matrix_value ();
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	896 retval = binmap<double> (m0, m1, math::mod<double>, "mod");
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	897 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	898 else
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	899 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	900 NDArray a0 = args(0).array_value ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	901 NDArray a1 = args(1).array_value ();
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	902 retval = binmap<double> (a0, a1, math::mod<double>, "mod");
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	903 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	904 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	905
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	906 return retval;
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	907 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	908
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	909 /*
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	910 ## empty input test
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	911 %!assert (isempty (mod ([], [])))
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	912
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	913 ## x mod y, y != 0 tests
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	914 %!assert (mod (5, 3), 2)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	915 %!assert (mod (-5, 3), 1)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	916 %!assert (mod (0, 3), 0)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	917 %!assert (mod ([-5, 5, 0], [3, 3, 3]), [1, 2, 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	918 %!assert (mod ([-5; 5; 0], [3; 3; 3]), [1; 2; 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	919 %!assert (mod ([-5, 5; 0, 3], [3, 3 ; 3, 1]), [1, 2 ; 0, 0])
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	920
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	921 ## x mod 0 tests
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	922 %!assert (mod (5, 0), 5)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	923 %!assert (mod (-5, 0), -5)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	924 %!assert (mod ([-5, 5, 0], [3, 0, 3]), [1, 5, 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	925 %!assert (mod ([-5; 5; 0], [3; 0; 3]), [1; 5; 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	926 %!assert (mod ([-5, 5; 0, 3], [3, 0 ; 3, 1]), [1, 5 ; 0, 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	927 %!assert (mod ([-5, 5; 0, 3], [0, 0 ; 0, 0]), [-5, 5; 0, 3])
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	928
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	929 ## mixed scalar/matrix tests
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	930 %!assert (mod ([-5, 5; 0, 3], 0), [-5, 5; 0, 3])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	931 %!assert (mod ([-5, 5; 0, 3], 3), [1, 2; 0, 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	932 %!assert (mod (-5, [0,0; 0,0]), [-5, -5; -5, -5])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	933 %!assert (mod (-5, [3,0; 3,1]), [1, -5; 1, 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	934 %!assert (mod (-5, [3,2; 3,1]), [1, 1; 1, 0])
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	935
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	936 ## integer types
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	937 %!assert (mod (uint8 (5), uint8 (4)), uint8 (1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	938 %!assert (mod (uint8 ([1:5]), uint8 (4)), uint8 ([1,2,3,0,1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	939 %!assert (mod (uint8 ([1:5]), uint8 (0)), uint8 ([1:5]))
28930 2883b3d08b7e maint: Remove unnecessary parentheses bracketing %!error BIST tests. Rik <rik@octave.org> parents: 28919 diff changeset	940 %!error mod (uint8 (5), int8 (4))
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	941
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	942 ## mixed integer/real types
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	943 %!assert (mod (uint8 (5), 4), uint8 (1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	944 %!assert (mod (5, uint8 (4)), uint8 (1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	945 %!assert (mod (uint8 ([1:5]), 4), uint8 ([1,2,3,0,1]))
11357 903c1a3df301 Add additional tests for mod with non-integer real values. Rik <octave@nomad.inbox5.com> parents: 11242 diff changeset	946
903c1a3df301 Add additional tests for mod with non-integer real values. Rik <octave@nomad.inbox5.com> parents: 11242 diff changeset	947 ## non-integer real numbers
903c1a3df301 Add additional tests for mod with non-integer real values. Rik <octave@nomad.inbox5.com> parents: 11242 diff changeset	948 %!assert (mod (2.1, 0.1), 0)
903c1a3df301 Add additional tests for mod with non-integer real values. Rik <octave@nomad.inbox5.com> parents: 11242 diff changeset	949 %!assert (mod (2.1, 0.2), 0.1, eps)
18869 23681c9ea7ba better guess if rem or mod could be zero (bug #42627) Olaf Till <i7tiol@t-online.de> parents: 18851 diff changeset	950
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	951 %!assert <*45587> (signbit (mod (-0, 0)))
1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	952 %!assert <*45587> (! signbit (mod (0, -0)))
1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	953
1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	954 %!assert <*42627> (mod (0.94, 0.01), 0.0)
25858 1f52a96c8c21 Fix mod operation for signed integer types (bug #54602). Gene Harvey <gharveymn@gmail.com> parents: 25578 diff changeset	955
1f52a96c8c21 Fix mod operation for signed integer types (bug #54602). Gene Harvey <gharveymn@gmail.com> parents: 25578 diff changeset	956 %!assert <*54602> (mod (int8 (125), int8 (-25)), int8 (0))
1f52a96c8c21 Fix mod operation for signed integer types (bug #54602). Gene Harvey <gharveymn@gmail.com> parents: 25578 diff changeset	957 %!assert <*54602> (mod (int8 (-125), int8 (-25)), int8 (0))
25860 60fd3c44769f Fix BIST test in cset 1f52a96c8c21. Rik <rik@octave.org> parents: 25858 diff changeset	958 %!assert <*54602> (mod (int8 (-125), int8 (0)), int8 (-125))
25858 1f52a96c8c21 Fix mod operation for signed integer types (bug #54602). Gene Harvey <gharveymn@gmail.com> parents: 25578 diff changeset	959 %!assert <*54602> (mod (int8 (0), int8 (-25)), int8 (0))
1f52a96c8c21 Fix mod operation for signed integer types (bug #54602). Gene Harvey <gharveymn@gmail.com> parents: 25578 diff changeset	960
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	961 */
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	962
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	963 #define DATA_REDUCTION(FCN) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	964 \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	965 int nargin = args.length (); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	966 \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	967 if (nargin < 1 \|\| nargin > 2) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	968 print_usage (); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	969 \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	970 octave_value retval; \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	971 \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	972 octave_value arg = args(0); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	973 \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	974 int dim = (nargin == 1 ? -1 : args(1).int_value (true) - 1); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	975 \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	976 if (dim < -1) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	977 error (#FCN ": invalid dimension argument = %d", dim + 1); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	978 \
23582 0cc2011d800e maint: Deprecate is_real_type and replace with isreal. Rik <rik@octave.org> parents: 23581 diff changeset	979 if (arg.isreal ()) \
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	980 { \
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	981 if (arg.issparse ()) \
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	982 { \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	983 SparseMatrix tmp = arg.sparse_matrix_value (); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	984 \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	985 retval = tmp.FCN (dim); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	986 } \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	987 else if (arg.is_single_type ()) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	988 { \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	989 FloatNDArray tmp = arg.float_array_value (); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	990 \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	991 retval = tmp.FCN (dim); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	992 } \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	993 else \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	994 { \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	995 NDArray tmp = arg.array_value (); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	996 \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	997 retval = tmp.FCN (dim); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	998 } \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	999 } \
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	1000 else if (arg.iscomplex ()) \
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1001 { \
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	1002 if (arg.issparse ()) \
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1003 { \
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	1004 SparseComplexMatrix tmp = arg.sparse_complex_matrix_value (); \
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1005 \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1006 retval = tmp.FCN (dim); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1007 } \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1008 else if (arg.is_single_type ()) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1009 { \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1010 FloatComplexNDArray tmp \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1011 = arg.float_complex_array_value (); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1012 \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1013 retval = tmp.FCN (dim); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1014 } \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1015 else \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1016 { \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1017 ComplexNDArray tmp = arg.complex_array_value (); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1018 \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1019 retval = tmp.FCN (dim); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1020 } \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1021 } \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1022 else \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1023 err_wrong_type_arg (#FCN, arg); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1024 \
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1025 return retval
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1026
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	1027 DEFUN (cumprod, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1028 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	1029 @deftypefn {} {@var{y} =} cumprod (@var{x})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	1030 @deftypefnx {} {@var{y} =} cumprod (@var{x}, @var{dim})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1031 Cumulative product of elements along dimension @var{dim}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1032
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1033 If @var{dim} is omitted, it defaults to the first non-singleton dimension.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1034 For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1035
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1036 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1037 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1038 cumprod ([1, 2; 3, 4; 5, 6])
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1039 @result{} 1 2
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1040 3 8
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1041 15 48
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1042 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1043 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1044 @seealso{prod, cumsum}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1045 @end deftypefn */)
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1046 {
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1047 DATA_REDUCTION (cumprod);
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1048 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1049
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1050 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1051 %!assert (cumprod ([1, 2, 3]), [1, 2, 6])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1052 %!assert (cumprod ([-1; -2; -3]), [-1; 2; -6])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1053 %!assert (cumprod ([i, 2+i, -3+2i, 4]), [i, -1+2i, -1-8i, -4-32i])
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1054 %!assert (cumprod ([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i]),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1055 %! [1, 2, 3; i, 4i, 9i; -1+i, -8+8i, -27+27i])
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1056
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1057 %!assert (cumprod (single ([1, 2, 3])), single ([1, 2, 6]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1058 %!assert (cumprod (single ([-1; -2; -3])), single ([-1; 2; -6]))
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1059 %!assert (cumprod (single ([i, 2+i, -3+2i, 4])),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1060 %! single ([i, -1+2i, -1-8i, -4-32i]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1061 %!assert (cumprod (single ([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i])),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1062 %! single ([1, 2, 3; i, 4i, 9i; -1+i, -8+8i, -27+27i]))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1063
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1064 %!assert (cumprod ([2, 3; 4, 5], 1), [2, 3; 8, 15])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1065 %!assert (cumprod ([2, 3; 4, 5], 2), [2, 6; 4, 20])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1066
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1067 %!assert (cumprod (single ([2, 3; 4, 5]), 1), single ([2, 3; 8, 15]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1068 %!assert (cumprod (single ([2, 3; 4, 5]), 2), single ([2, 6; 4, 20]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1069
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1070 %!error cumprod ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1071 */
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1072
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	1073 DEFUN (cumsum, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1074 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	1075 @deftypefn {} {@var{y} =} cumsum (@var{x})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	1076 @deftypefnx {} {@var{y} =} cumsum (@var{x}, @var{dim})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	1077 @deftypefnx {} {@var{y} =} cumsum (@dots{}, "native")
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	1078 @deftypefnx {} {@var{y} =} cumsum (@dots{}, "double")
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1079 Cumulative sum of elements along dimension @var{dim}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1080
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1081 If @var{dim} is omitted, it defaults to the first non-singleton dimension.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1082 For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1083
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1084 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1085 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1086 cumsum ([1, 2; 3, 4; 5, 6])
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1087 @result{} 1 2
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1088 4 6
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1089 9 12
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1090 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1091 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1092
28960 e5a1087f15d5 doc: Use @xref, @pxref rather than "see @code{}" in TexInfo in libinterp/ Rik <rik@octave.org> parents: 28930 diff changeset	1093 For an explanation of the optional parameters @qcode{"native"} and
e5a1087f15d5 doc: Use @xref, @pxref rather than "see @code{}" in TexInfo in libinterp/ Rik <rik@octave.org> parents: 28930 diff changeset	1094 @qcode{"double"}, @pxref{XREFsum,,@code{sum}}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1095 @seealso{sum, cumprod}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1096 @end deftypefn */)
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1097 {
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1098 int nargin = args.length ();
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1099
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1100 bool isnative = false;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1101 bool isdouble = false;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1102
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1103 if (nargin > 1 && args(nargin - 1).is_string ())
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1104 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1105 std::string str = args(nargin - 1).string_value ();
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1106
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19739 diff changeset	1107 if (str == "native")
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19739 diff changeset	1108 isnative = true;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19739 diff changeset	1109 else if (str == "double")
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19739 diff changeset	1110 isdouble = true;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19739 diff changeset	1111 else
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19739 diff changeset	1112 error ("cumsum: unrecognized string argument");
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	1113
21062 d9c1884d1aaa maint: Eliminate space between variable and decrement '--' operator. Rik <rik@octave.org> parents: 21055 diff changeset	1114 nargin--;
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1115 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1116
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1117 if (nargin < 1 \|\| nargin > 2)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1118 print_usage ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1119
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1120 int dim = -1;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1121 if (nargin == 2)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1122 {
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1123 dim = args(1).int_value () - 1;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1124 if (dim < 0)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1125 error ("cumsum: invalid dimension argument = %d", dim + 1);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1126 }
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1127
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	1128 octave_value retval;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	1129 octave_value arg = args(0);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	1130
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1131 switch (arg.builtin_type ())
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1132 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1133 case btyp_double:
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	1134 if (arg.issparse ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1135 retval = arg.sparse_matrix_value ().cumsum (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1136 else
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1137 retval = arg.array_value ().cumsum (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1138 break;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1139 case btyp_complex:
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	1140 if (arg.issparse ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1141 retval = arg.sparse_complex_matrix_value ().cumsum (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1142 else
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1143 retval = arg.complex_array_value ().cumsum (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1144 break;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1145 case btyp_float:
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1146 if (isdouble)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1147 retval = arg.array_value ().cumsum (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1148 else
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1149 retval = arg.float_array_value ().cumsum (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1150 break;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1151 case btyp_float_complex:
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1152 if (isdouble)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1153 retval = arg.complex_array_value ().cumsum (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1154 else
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1155 retval = arg.float_complex_array_value ().cumsum (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1156 break;
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1157
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1158 #define MAKE_INT_BRANCH(X) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1159 case btyp_ ## X: \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1160 if (isnative) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1161 retval = arg.X ## _array_value ().cumsum (dim); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1162 else \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1163 retval = arg.array_value ().cumsum (dim); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1164 break;
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1165
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1166 MAKE_INT_BRANCH (int8);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1167 MAKE_INT_BRANCH (int16);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1168 MAKE_INT_BRANCH (int32);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1169 MAKE_INT_BRANCH (int64);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1170 MAKE_INT_BRANCH (uint8);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1171 MAKE_INT_BRANCH (uint16);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1172 MAKE_INT_BRANCH (uint32);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1173 MAKE_INT_BRANCH (uint64);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1174
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1175 #undef MAKE_INT_BRANCH
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1176
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1177 case btyp_bool:
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	1178 if (arg.issparse ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1179 {
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1180 SparseMatrix cs = arg.sparse_matrix_value ().cumsum (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1181 if (isnative)
26357 bba4b338757d data.cc: Fix static analyzer detected issues (bug #55347). Rik <rik@octave.org> parents: 26292 diff changeset	1182 retval = (cs != 0.0);
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	1183 else
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1184 retval = cs;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1185 }
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1186 else
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1187 {
22773 7f70e420e342 deprecate boolNDArray::sum and boolNDArray::cumsum John W. Eaton <jwe@octave.org> parents: 22763 diff changeset	1188 NDArray cs = arg.array_value ().cumsum (dim);
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1189 if (isnative)
26357 bba4b338757d data.cc: Fix static analyzer detected issues (bug #55347). Rik <rik@octave.org> parents: 26292 diff changeset	1190 retval = (cs != 0.0);
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1191 else
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1192 retval = cs;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1193 }
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1194 break;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1195
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1196 default:
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21078 diff changeset	1197 err_wrong_type_arg ("cumsum", arg);
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1198 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1199
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1200 return retval;
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1201 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1202
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1203 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1204 %!assert (cumsum ([1, 2, 3]), [1, 3, 6])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1205 %!assert (cumsum ([-1; -2; -3]), [-1; -3; -6])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1206 %!assert (cumsum ([i, 2+i, -3+2i, 4]), [i, 2+2i, -1+4i, 3+4i])
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1207 %!assert (cumsum ([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i]),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1208 %! [1, 2, 3; 1+i, 2+2i, 3+3i; 2+2i, 4+4i, 6+6i])
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1209
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1210 %!assert (cumsum (single ([1, 2, 3])), single ([1, 3, 6]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1211 %!assert (cumsum (single ([-1; -2; -3])), single ([-1; -3; -6]))
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1212 %!assert (cumsum (single ([i, 2+i, -3+2i, 4])),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1213 %! single ([i, 2+2i, -1+4i, 3+4i]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1214 %!assert (cumsum (single ([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i])),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1215 %! single ([1, 2, 3; 1+i, 2+2i, 3+3i; 2+2i, 4+4i, 6+6i]))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1216
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1217 %!assert (cumsum ([1, 2; 3, 4], 1), [1, 2; 4, 6])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1218 %!assert (cumsum ([1, 2; 3, 4], 2), [1, 3; 3, 7])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1219
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1220 %!assert (cumsum (single ([1, 2; 3, 4]), 1), single ([1, 2; 4, 6]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1221 %!assert (cumsum (single ([1, 2; 3, 4]), 2), single ([1, 3; 3, 7]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1222
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1223 %!error cumsum ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1224 */
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1225
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	1226 DEFUN (diag, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1227 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1228 @deftypefn {} {@var{M} =} diag (@var{v})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1229 @deftypefnx {} {@var{M} =} diag (@var{v}, @var{k})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1230 @deftypefnx {} {@var{M} =} diag (@var{v}, @var{m}, @var{n})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1231 @deftypefnx {} {@var{v} =} diag (@var{M})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1232 @deftypefnx {} {@var{v} =} diag (@var{M}, @var{k})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1233 Return a diagonal matrix with vector @var{v} on diagonal @var{k}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1234
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1235 The second argument is optional. If it is positive, the vector is placed on
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1236 the @var{k}-th superdiagonal. If it is negative, it is placed on the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1237 @var{-k}-th subdiagonal. The default value of @var{k} is 0, and the vector
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1238 is placed on the main diagonal. For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1239
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1240 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1241 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1242 diag ([1, 2, 3], 1)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1243 @result{} 0 1 0 0
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1244 0 0 2 0
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1245 0 0 0 3
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1246 0 0 0 0
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1247 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1248 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1249
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1250 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1251 The 3-input form returns a diagonal matrix with vector @var{v} on the main
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1252 diagonal and the resulting matrix being of size @var{m} rows x @var{n}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1253 columns.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1254
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1255 Given a matrix argument, instead of a vector, @code{diag} extracts the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1256 @var{k}-th diagonal of the matrix.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1257 @end deftypefn */)
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1258 {
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1259 int nargin = args.length ();
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1260
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1261 if (nargin < 1 \|\| nargin > 3)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1262 print_usage ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1263
4233 ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe] jwe parents: 4176 diff changeset	1264 octave_value retval;
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1265
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1266 if (nargin == 1)
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1267 retval = args(0).diag ();
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1268 else if (nargin == 2)
7620 36594d5bbe13 Move diag function into the octave_value class David Bateman <dbateman@free.fr> parents: 7618 diff changeset	1269 {
33446 5fded8395daa rename yTYPE_value functions strict_TYPE_value John W. Eaton <jwe@octave.org> parents: 33382 diff changeset	1270 octave_idx_type k = args(1).strict_idx_type_value ("diag: invalid argument K");
20704 571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	1271
571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	1272 retval = args(0).diag (k);
7620 36594d5bbe13 Move diag function into the octave_value class David Bateman <dbateman@free.fr> parents: 7618 diff changeset	1273 }
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1274 else
12570 1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1275 {
1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1276 octave_value arg0 = args(0);
14557 e8e86ae3abbc make diag (x, m, n) return a proper diagonal matrix object (bug #36099) John W. Eaton <jwe@octave.org> parents: 14521 diff changeset	1277
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	1278 if (arg0.ndims () != 2 \|\| (arg0.rows () != 1 && arg0.columns () != 1))
12570 1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1279 error ("diag: V must be a vector");
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	1280
33446 5fded8395daa rename yTYPE_value functions strict_TYPE_value John W. Eaton <jwe@octave.org> parents: 33382 diff changeset	1281 octave_idx_type m = args(1).strict_idx_type_value ("diag: invalid dimension M");
5fded8395daa rename yTYPE_value functions strict_TYPE_value John W. Eaton <jwe@octave.org> parents: 33382 diff changeset	1282 octave_idx_type n = args(2).strict_idx_type_value ("diag: invalid dimension N");
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	1283
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	1284 retval = arg0.diag (m, n);
12570 1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1285 }
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1286
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1287 return retval;
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1288 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1289
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1290 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1291
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1292 %!assert (full (diag ([1; 2; 3])), [1, 0, 0; 0, 2, 0; 0, 0, 3])
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1293 %!assert (diag ([1; 2; 3], 1), [0, 1, 0, 0; 0, 0, 2, 0; 0, 0, 0, 3; 0, 0, 0, 0])
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1294 %!assert (diag ([1; 2; 3], 2),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1295 %! [0 0 1 0 0; 0 0 0 2 0; 0 0 0 0 3; 0 0 0 0 0; 0 0 0 0 0])
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1296 %!assert (diag ([1; 2; 3],-1),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1297 %! [0 0 0 0; 1 0 0 0; 0 2 0 0; 0 0 3 0])
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1298 %!assert (diag ([1; 2; 3],-2),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1299 %! [0 0 0 0 0; 0 0 0 0 0; 1 0 0 0 0; 0 2 0 0 0; 0 0 3 0 0])
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1300
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1301 %!assert (diag ([1, 0, 0; 0, 2, 0; 0, 0, 3]), [1; 2; 3])
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1302 %!assert (diag ([0, 1, 0, 0; 0, 0, 2, 0; 0, 0, 0, 3; 0, 0, 0, 0], 1),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1303 %! [1; 2; 3])
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1304 %!assert (diag ([0, 0, 0, 0; 1, 0, 0, 0; 0, 2, 0, 0; 0, 0, 3, 0], -1),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1305 %! [1; 2; 3])
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1306 %!assert (diag (ones (1, 0), 2), zeros (2))
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1307 %!assert (diag (1:3, 4, 2), [1, 0; 0, 2; 0, 0; 0, 0])
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1308
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1309 %!assert (full (diag (single ([1; 2; 3]))),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1310 %! single ([1, 0, 0; 0, 2, 0; 0, 0, 3]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1311 %!assert (diag (single ([1; 2; 3]), 1),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1312 %! single ([0, 1, 0, 0; 0, 0, 2, 0; 0, 0, 0, 3; 0, 0, 0, 0]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1313 %!assert (diag (single ([1; 2; 3]), 2),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1314 %! single ([0 0 1 0 0; 0 0 0 2 0; 0 0 0 0 3; 0 0 0 0 0; 0 0 0 0 0]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1315 %!assert (diag (single ([1; 2; 3]),-1),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1316 %! single ([0, 0, 0, 0; 1, 0, 0, 0; 0, 2, 0, 0; 0, 0, 3, 0]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1317 %!assert (diag (single ([1; 2; 3]),-2),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1318 %! single ([0 0 0 0 0; 0 0 0 0 0; 1 0 0 0 0; 0 2 0 0 0; 0 0 3 0 0]))
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1319
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1320 %!assert (diag (single ([1, 0, 0; 0, 2, 0; 0, 0, 3])), single ([1; 2; 3]))
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1321 %!assert (diag (single ([0, 1, 0, 0; 0, 0, 2, 0; 0, 0, 0, 3; 0, 0, 0, 0]), 1),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1322 %! single ([1; 2; 3]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1323 %!assert (diag (single ([0, 0, 0, 0; 1, 0, 0, 0; 0, 2, 0, 0; 0, 0, 3, 0]), -1),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1324 %! single ([1; 2; 3]))
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1325
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1326 %!assert (diag (int8 ([1; 2; 3])), int8 ([1, 0, 0; 0, 2, 0; 0, 0, 3]))
30402 1ef9fca2db06 maint: strip trailing spaces from codebase. Rik <rik@octave.org> parents: 30391 diff changeset	1327 %!assert (diag (int8 ([1; 2; 3]), 1),
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1328 %! int8 ([0, 1, 0, 0; 0, 0, 2, 0; 0, 0, 0, 3; 0, 0, 0, 0]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1329 %!assert (diag (int8 ([1; 2; 3]), 2),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1330 %! int8 ([0 0 1 0 0; 0 0 0 2 0; 0 0 0 0 3; 0 0 0 0 0; 0 0 0 0 0]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1331 %!assert (diag (int8 ([1; 2; 3]),-1),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1332 %! int8 ([0 0 0 0; 1 0 0 0; 0 2 0 0; 0 0 3 0]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1333 %!assert (diag (int8 ([1; 2; 3]),-2),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1334 %! int8 ([0 0 0 0 0; 0 0 0 0 0; 1 0 0 0 0; 0 2 0 0 0; 0 0 3 0 0]))
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1335
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1336 %!assert (diag (int8 ([1, 0, 0; 0, 2, 0; 0, 0, 3])), int8 ([1; 2; 3]))
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1337 %!assert (diag (int8 ([0, 1, 0, 0; 0, 0, 2, 0; 0, 0, 0, 3; 0, 0, 0, 0]), 1),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1338 %! int8 ([1; 2; 3]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1339 %!assert (diag (int8 ([0, 0, 0, 0; 1, 0, 0, 0; 0, 2, 0, 0; 0, 0, 3, 0]), -1),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1340 %! int8 ([1; 2; 3]))
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1341
27325 983dab0902f7 More explicit error messages for invalid 2nd and 3rd inputs to diag(). Rik <rik@octave.org> parents: 27324 diff changeset	1342 %!assert (diag (1, 3, 3), diag ([1, 0, 0]))
983dab0902f7 More explicit error messages for invalid 2nd and 3rd inputs to diag(). Rik <rik@octave.org> parents: 27324 diff changeset	1343 %!assert (diag (i, 3, 3), diag ([i, 0, 0]))
983dab0902f7 More explicit error messages for invalid 2nd and 3rd inputs to diag(). Rik <rik@octave.org> parents: 27324 diff changeset	1344 %!assert (diag (single (1), 3, 3), diag ([single(1), 0, 0]))
983dab0902f7 More explicit error messages for invalid 2nd and 3rd inputs to diag(). Rik <rik@octave.org> parents: 27324 diff changeset	1345 %!assert (diag (single (i), 3, 3), diag ([single(i), 0, 0]))
983dab0902f7 More explicit error messages for invalid 2nd and 3rd inputs to diag(). Rik <rik@octave.org> parents: 27324 diff changeset	1346 %!assert (diag ([1, 2], 3, 3), diag ([1, 2, 0]))
983dab0902f7 More explicit error messages for invalid 2nd and 3rd inputs to diag(). Rik <rik@octave.org> parents: 27324 diff changeset	1347 %!assert (diag ([1, 2]i, 3, 3), diag ([1, 2, 0]i))
983dab0902f7 More explicit error messages for invalid 2nd and 3rd inputs to diag(). Rik <rik@octave.org> parents: 27324 diff changeset	1348 %!assert (diag (single ([1, 2]), 3, 3), diag (single ([1, 2, 0])))
983dab0902f7 More explicit error messages for invalid 2nd and 3rd inputs to diag(). Rik <rik@octave.org> parents: 27324 diff changeset	1349 %!assert (diag (single ([1, 2]i), 3, 3), diag (single ([1, 2, 0]i)))
983dab0902f7 More explicit error messages for invalid 2nd and 3rd inputs to diag(). Rik <rik@octave.org> parents: 27324 diff changeset	1350
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	1351 %!assert <*37411> (diag (diag ([5, 2, 3])(:,1)), diag([5 0 0 ]))
1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	1352 %!assert <*37411> (diag (diag ([5, 2, 3])(:,1), 2), [0 0 5 0 0; zeros(4, 5)])
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1353 %!assert <*37411> (diag (diag ([5, 2, 3])(:,1), -2),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1354 %! [[0 0 5 0 0]', zeros(5, 4)])
15428 fd5c0159b588 Fix diag handling of diagvectors (bug #37411) Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14567 diff changeset	1355
14490 3959f3f81e33 Initialise memory in non-square diag call (bug #35946) Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14171 diff changeset	1356 ## Test non-square size
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1357 %!assert (diag ([1,2,3], 6, 3), [1 0 0; 0 2 0; 0 0 3; 0 0 0; 0 0 0; 0 0 0])
21317 a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions. Rik <rik@octave.org> parents: 21301 diff changeset	1358 %!assert (diag (1, 2, 3), [1,0,0; 0,0,0])
a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions. Rik <rik@octave.org> parents: 21301 diff changeset	1359 %!assert (diag ({1}, 2, 3), {1,[],[]; [],[],[]})
a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions. Rik <rik@octave.org> parents: 21301 diff changeset	1360 %!assert (diag ({1,2}, 3, 4), {1,[],[],[]; [],2,[],[]; [],[],[],[]})
27323 1582a6140275 Stop segfault when calling 3-input form of diag with cell arrays (bug #56711). Rik <rik@octave.org> parents: 27081 diff changeset	1361 %!assert <*56711> (diag ({1,2,3}, 2, 1), {1; []})
14490 3959f3f81e33 Initialise memory in non-square diag call (bug #35946) Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14171 diff changeset	1362
18146 a86d608c413c Return empty matrix rather than issuing error when requested diagonal is out of range. Marco Caliari <marco.caliari@univr.it> parents: 18112 diff changeset	1363 ## Test out-of-range diagonals
a86d608c413c Return empty matrix rather than issuing error when requested diagonal is out of range. Marco Caliari <marco.caliari@univr.it> parents: 18112 diff changeset	1364 %!assert (diag (ones (3,3), 4), zeros (0, 1))
a86d608c413c Return empty matrix rather than issuing error when requested diagonal is out of range. Marco Caliari <marco.caliari@univr.it> parents: 18112 diff changeset	1365 %!assert (diag (cell (3,3), 4), cell (0, 1))
a86d608c413c Return empty matrix rather than issuing error when requested diagonal is out of range. Marco Caliari <marco.caliari@univr.it> parents: 18112 diff changeset	1366 %!assert (diag (sparse (ones (3,3)), 4), sparse (zeros (0, 1)))
a86d608c413c Return empty matrix rather than issuing error when requested diagonal is out of range. Marco Caliari <marco.caliari@univr.it> parents: 18112 diff changeset	1367
22737 7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22708 diff changeset	1368 ## Test input validation
14491 5bd9e47e9277 maint: periodic merge of stable to default Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14429 14490 diff changeset	1369 %!error <Invalid call to diag> diag ()
5bd9e47e9277 maint: periodic merge of stable to default Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14429 14490 diff changeset	1370 %!error <Invalid call to diag> diag (1,2,3,4)
27325 983dab0902f7 More explicit error messages for invalid 2nd and 3rd inputs to diag(). Rik <rik@octave.org> parents: 27324 diff changeset	1371 %!error <V must be a vector> diag (ones (2), 3, 3)
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1372 %!error diag (1:3, -4, 3)
27325 983dab0902f7 More explicit error messages for invalid 2nd and 3rd inputs to diag(). Rik <rik@octave.org> parents: 27324 diff changeset	1373 %!error diag (1:3, 4, -3)
983dab0902f7 More explicit error messages for invalid 2nd and 3rd inputs to diag(). Rik <rik@octave.org> parents: 27324 diff changeset	1374
14557 e8e86ae3abbc make diag (x, m, n) return a proper diagonal matrix object (bug #36099) John W. Eaton <jwe@octave.org> parents: 14521 diff changeset	1375 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1376
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	1377 DEFUN (prod, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1378 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	1379 @deftypefn {} {@var{y} =} prod (@var{x})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	1380 @deftypefnx {} {@var{y} =} prod (@var{x}, @var{dim})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	1381 @deftypefnx {} {@var{y} =} prod (@dots{}, "native")
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	1382 @deftypefnx {} {@var{y} =} prod (@dots{}, "double")
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1383 Product of elements along dimension @var{dim}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1384
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1385 If @var{dim} is omitted, it defaults to the first non-singleton dimension.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1386
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1387 The optional @qcode{"type"} input determines the class of the variable
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1388 used for calculations. If the argument @qcode{"native"} is given, then
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1389 the operation is performed in the same type as the original argument, rather
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1390 than the default double type.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1391
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1392 For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1393
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1394 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1395 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1396 prod ([true, true])
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1397 @result{} 1
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1398 prod ([true, true], "native")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1399 @result{} true
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1400 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1401 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1402
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1403 On the contrary, if @qcode{"double"} is given, the operation is performed
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1404 in double precision even for single precision inputs.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1405 @seealso{cumprod, sum}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	1406 @end deftypefn */)
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1407 {
18725 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1408 int nargin = args.length ();
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1409
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1410 bool isnative = false;
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1411 bool isdouble = false;
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1412
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1413 if (nargin > 1 && args(nargin - 1).is_string ())
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1414 {
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1415 std::string str = args(nargin - 1).string_value ();
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1416
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19739 diff changeset	1417 if (str == "native")
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19739 diff changeset	1418 isnative = true;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19739 diff changeset	1419 else if (str == "double")
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19739 diff changeset	1420 isdouble = true;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19739 diff changeset	1421 else
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19739 diff changeset	1422 error ("prod: unrecognized type argument '%s'", str.c_str ());
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	1423
21062 d9c1884d1aaa maint: Eliminate space between variable and decrement '--' operator. Rik <rik@octave.org> parents: 21055 diff changeset	1424 nargin--;
18725 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1425 }
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1426
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1427 if (nargin < 1 \|\| nargin > 2)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1428 print_usage ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1429
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	1430 octave_value retval;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	1431
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1432 octave_value arg = args(0);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1433
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1434 int dim = -1;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1435 if (nargin == 2)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1436 {
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1437 dim = args(1).int_value () - 1;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1438 if (dim < 0)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1439 error ("prod: invalid dimension DIM = %d", dim + 1);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1440 }
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1441
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1442 switch (arg.builtin_type ())
18725 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1443 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1444 case btyp_double:
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	1445 if (arg.issparse ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1446 retval = arg.sparse_matrix_value ().prod (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1447 else
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1448 retval = arg.array_value ().prod (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1449 break;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1450 case btyp_complex:
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	1451 if (arg.issparse ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1452 retval = arg.sparse_complex_matrix_value ().prod (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1453 else
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1454 retval = arg.complex_array_value ().prod (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1455 break;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1456 case btyp_float:
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1457 if (isdouble)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1458 retval = arg.float_array_value ().dprod (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1459 else
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1460 retval = arg.float_array_value ().prod (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1461 break;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1462 case btyp_float_complex:
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1463 if (isdouble)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1464 retval = arg.float_complex_array_value ().dprod (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1465 else
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1466 retval = arg.float_complex_array_value ().prod (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1467 break;
18725 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1468
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1469 #define MAKE_INT_BRANCH(X) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1470 case btyp_ ## X: \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1471 if (isnative) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1472 retval = arg.X ## _array_value ().prod (dim); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1473 else \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1474 retval = arg.array_value ().prod (dim); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	1475 break;
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1476
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1477 MAKE_INT_BRANCH (int8);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1478 MAKE_INT_BRANCH (int16);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1479 MAKE_INT_BRANCH (int32);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1480 MAKE_INT_BRANCH (int64);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1481 MAKE_INT_BRANCH (uint8);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1482 MAKE_INT_BRANCH (uint16);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1483 MAKE_INT_BRANCH (uint32);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1484 MAKE_INT_BRANCH (uint64);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1485
18725 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1486 #undef MAKE_INT_BRANCH
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1487
22407 34ce5be04942 maint: Style check C++ code in libinterp/. Rik <rik@octave.org> parents: 22327 diff changeset	1488 // GAGME: Accursed Matlab compatibility...
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1489 case btyp_char:
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1490 retval = arg.array_value (true).prod (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1491 break;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1492
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1493 case btyp_bool:
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	1494 if (arg.issparse ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1495 {
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1496 if (isnative)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1497 retval = arg.sparse_bool_matrix_value ().all (dim);
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	1498 else
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1499 retval = arg.sparse_matrix_value ().prod (dim);
18725 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1500 }
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1501 else if (isnative)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1502 retval = arg.bool_array_value ().all (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1503 else
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1504 retval = NDArray (arg.bool_array_value ().all (dim));
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1505 break;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1506
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1507 default:
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21078 diff changeset	1508 err_wrong_type_arg ("prod", arg);
18725 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1509 }
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1510
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1511 return retval;
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1512 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1513
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1514 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1515 %!assert (prod ([1, 2, 3]), 6)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1516 %!assert (prod ([-1; -2; -3]), -6)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1517 %!assert (prod ([i, 2+i, -3+2i, 4]), -4 - 32i)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1518 %!assert (prod ([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i]), [-1+i, -8+8i, -27+27i])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1519
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1520 %!assert (prod (single ([1, 2, 3])), single (6))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1521 %!assert (prod (single ([-1; -2; -3])), single (-6))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1522 %!assert (prod (single ([i, 2+i, -3+2i, 4])), single (-4 - 32i))
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1523 %!assert (prod (single ([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i])),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1524 %! single ([-1+i, -8+8i, -27+27i]))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1525
22737 7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22708 diff changeset	1526 ## Test sparse
18725 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1527 %!assert (prod (sparse ([1, 2, 3])), sparse (6))
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1528 %!assert (prod (sparse ([-1; -2; -3])), sparse (-6))
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1529 ## Commented out until bug #42290 is fixed
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1530 #%!assert (prod (sparse ([i, 2+i, -3+2i, 4])), sparse (-4 - 32i))
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1531 #%!assert (prod (sparse ([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i])),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1532 #%! sparse ([-1+i, -8+8i, -27+27i]))
18725 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1533
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1534 %!assert (prod ([1, 2; 3, 4], 1), [3, 8])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1535 %!assert (prod ([1, 2; 3, 4], 2), [2; 12])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1536 %!assert (prod (zeros (1, 0)), 1)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1537 %!assert (prod (zeros (1, 0), 1), zeros (1, 0))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1538 %!assert (prod (zeros (1, 0), 2), 1)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1539 %!assert (prod (zeros (0, 1)), 1)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1540 %!assert (prod (zeros (0, 1), 1), 1)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1541 %!assert (prod (zeros (0, 1), 2), zeros (0, 1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1542 %!assert (prod (zeros (2, 0)), zeros (1, 0))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1543 %!assert (prod (zeros (2, 0), 1), zeros (1, 0))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1544 %!assert (prod (zeros (2, 0), 2), [1; 1])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1545 %!assert (prod (zeros (0, 2)), [1, 1])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1546 %!assert (prod (zeros (0, 2), 1), [1, 1])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1547 %!assert (prod (zeros (0, 2), 2), zeros (0, 1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1548
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1549 %!assert (prod (single ([1, 2; 3, 4]), 1), single ([3, 8]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1550 %!assert (prod (single ([1, 2; 3, 4]), 2), single ([2; 12]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1551 %!assert (prod (zeros (1, 0, "single")), single (1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1552 %!assert (prod (zeros (1, 0, "single"), 1), zeros (1, 0, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1553 %!assert (prod (zeros (1, 0, "single"), 2), single (1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1554 %!assert (prod (zeros (0, 1, "single")), single (1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1555 %!assert (prod (zeros (0, 1, "single"), 1), single (1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1556 %!assert (prod (zeros (0, 1, "single"), 2), zeros (0, 1, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1557 %!assert (prod (zeros (2, 0, "single")), zeros (1, 0, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1558 %!assert (prod (zeros (2, 0, "single"), 1), zeros (1, 0, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1559 %!assert (prod (zeros (2, 0, "single"), 2), single ([1; 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1560 %!assert (prod (zeros (0, 2, "single")), single ([1, 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1561 %!assert (prod (zeros (0, 2, "single"), 1), single ([1, 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1562 %!assert (prod (zeros (0, 2, "single"), 2), zeros (0, 1, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1563
22737 7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22708 diff changeset	1564 ## Test "double" type argument
18725 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1565 %!assert (prod (single ([1, 2, 3]), "double"), 6)
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1566 %!assert (prod (single ([-1; -2; -3]), "double"), -6)
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1567 %!assert (prod (single ([i, 2+i, -3+2i, 4]), "double"), -4 - 32i)
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1568 %!assert (prod (single ([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i]), "double"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	1569 %! [-1+i, -8+8i, -27+27i])
18725 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1570
22737 7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22708 diff changeset	1571 ## Test "native" type argument
18725 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1572 %!assert (prod (uint8 ([1, 2, 3]), "native"), uint8 (6))
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1573 %!assert (prod (uint8 ([-1; -2; -3]), "native"), uint8 (0))
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1574 %!assert (prod (int8 ([1, 2, 3]), "native"), int8 (6))
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1575 %!assert (prod (int8 ([-1; -2; -3]), "native"), int8 (-6))
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1576 %!assert (prod ([true false; true true], "native"), [true false])
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1577 %!assert (prod ([true false; true true], 2, "native"), [false; true])
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1578
22737 7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22708 diff changeset	1579 ## Test input validation
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1580 %!error prod ()
18725 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1581 %!error prod (1,2,3)
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18679 diff changeset	1582 %!error <unrecognized type argument 'foobar'> prod (1, "foobar")
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1583 */
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1584
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1585 static bool
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1586 all_scalar_1x1 (const octave_value_list& args)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1587 {
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1588 int n_args = args.length ();
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1589 for (int i = 0; i < n_args; i++)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1590 if (args(i).numel () != 1)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1591 return false;
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1592
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1593 return true;
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1594 }
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1595
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21129 diff changeset	1596 template <typename TYPE, typename T>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1597 static void
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1598 single_type_concat (Array<T>& result,
f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1599 const octave_value_list& args,
f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1600 int dim)
f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1601 {
f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1602 int n_args = args.length ();
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1603 if (! (equal_types<T, char>::value
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1604 \|\| equal_types<T, octave_value>::value)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1605 && all_scalar_1x1 (args))
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1606 {
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1607 // Optimize all scalars case.
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1608 dim_vector dv (1, 1);
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1609 if (dim == -1 \|\| dim == -2)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1610 dim = -dim - 1;
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1611 else if (dim >= 2)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1612 dv.resize (dim+1, 1);
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1613 dv(dim) = n_args;
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1614
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1615 result.clear (dv);
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1616
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	1617 for (int j = 0; j < n_args; j++)
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1618 {
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1619 octave_quit ();
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1620
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1621 result(j) = octave_value_extract<T> (args(j));
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1622 }
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1623 }
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1624 else
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1625 {
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1626 OCTAVE_LOCAL_BUFFER (Array<T>, array_list, n_args);
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1627
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	1628 for (int j = 0; j < n_args; j++)
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1629 {
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1630 octave_quit ();
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1631
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1632 array_list[j] = octave_value_extract<TYPE> (args(j));
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1633 }
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1634
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	1635 result = Array<T>::cat (dim, n_args, array_list);
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1636 }
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1637 }
f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1638
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21129 diff changeset	1639 template <typename TYPE, typename T>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1640 static void
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1641 single_type_concat (Sparse<T>& result,
10498 8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1642 const octave_value_list& args,
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1643 int dim)
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1644 {
32807 07ff21a1dd1c Try to avoid warning about possible integer range overflow from GCC. Markus Mützel <markus.muetzel@gmx.de> parents: 32632 diff changeset	1645 octave_idx_type n_args = args.length ();
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1646 OCTAVE_LOCAL_BUFFER (Sparse<T>, sparse_list, n_args);
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1647
32807 07ff21a1dd1c Try to avoid warning about possible integer range overflow from GCC. Markus Mützel <markus.muetzel@gmx.de> parents: 32632 diff changeset	1648 for (octave_idx_type j = 0; j < n_args; j++)
10498 8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1649 {
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1650 octave_quit ();
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1651
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1652 sparse_list[j] = octave_value_extract<TYPE> (args(j));
10498 8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1653 }
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1654
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	1655 result = Sparse<T>::cat (dim, n_args, sparse_list);
10498 8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1656 }
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1657
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1658 // Dispatcher.
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21129 diff changeset	1659 template <typename TYPE>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1660 static TYPE
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1661 do_single_type_concat (const octave_value_list& args, int dim)
10498 8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1662 {
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1663 TYPE result;
f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1664
f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1665 single_type_concat<TYPE, typename TYPE::element_type> (result, args, dim);
10498 8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1666
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1667 return result;
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1668 }
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1669
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21129 diff changeset	1670 template <typename MAP>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1671 static void
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1672 single_type_concat_map (octave_map& result,
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1673 const octave_value_list& args,
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1674 int dim)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1675 {
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1676 int n_args = args.length ();
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1677 OCTAVE_LOCAL_BUFFER (MAP, map_list, n_args);
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1678
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	1679 for (int j = 0; j < n_args; j++)
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1680 {
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1681 octave_quit ();
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1682
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1683 map_list[j] = octave_value_extract<MAP> (args(j));
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1684 }
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1685
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	1686 result = octave_map::cat (dim, n_args, map_list);
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1687 }
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1688
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1689 static octave_map
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1690 do_single_type_concat_map (const octave_value_list& args,
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1691 int dim)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1692 {
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1693 octave_map result;
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1694 if (all_scalar_1x1 (args)) // optimize all scalars case.
10763 b397b8edd8c5 fix off-by-1 dim in scalar map horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10758 diff changeset	1695 single_type_concat_map<octave_scalar_map> (result, args, dim);
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1696 else
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1697 single_type_concat_map<octave_map> (result, args, dim);
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1698
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1699 return result;
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1700 }
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1701
4824 4829055e154f [project @ 2004-03-08 18:16:04 by jwe] jwe parents: 4806 diff changeset	1702 static octave_value
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1703 attempt_type_conversion (const octave_value& ov, std::string dtype)
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1704 {
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1705 octave_value retval;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1706
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1707 // First try to find function in the class of OV that can convert to
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1708 // the dispatch type dtype. It will have the name of the dispatch
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1709 // type.
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1710
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1711 std::string cname = ov.class_name ();
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1712
31730 610a85b0ff62 use interpreter::feval instead of global feval function John W. Eaton <jwe@octave.org> parents: 31707 diff changeset	1713 interpreter& interp = __get_interpreter__ ();
610a85b0ff62 use interpreter::feval instead of global feval function John W. Eaton <jwe@octave.org> parents: 31707 diff changeset	1714
610a85b0ff62 use interpreter::feval instead of global feval function John W. Eaton <jwe@octave.org> parents: 31707 diff changeset	1715 symbol_table& symtab = interp.get_symbol_table ();
23599 5cb3a2bb5e1e don't use singleton for symbol_table John W. Eaton <jwe@octave.org> parents: 23592 diff changeset	1716
5cb3a2bb5e1e don't use singleton for symbol_table John W. Eaton <jwe@octave.org> parents: 23592 diff changeset	1717 octave_value fcn = symtab.find_method (dtype, cname);
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1718
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1719 if (fcn.is_defined ())
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1720 {
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20726 diff changeset	1721 octave_value_list result;
a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20726 diff changeset	1722
a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20726 diff changeset	1723 try
a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20726 diff changeset	1724 {
31730 610a85b0ff62 use interpreter::feval instead of global feval function John W. Eaton <jwe@octave.org> parents: 31707 diff changeset	1725 result = interp.feval (fcn, ovl (ov), 1);
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20726 diff changeset	1726 }
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	1727 catch (execution_exception& ee)
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20726 diff changeset	1728 {
29163 8f67ad8b3103 maint: Updating naming conventions for exceptions and use const where possible. Rik <rik@octave.org> parents: 29117 diff changeset	1729 error (ee, "conversion from %s to %s failed", dtype.c_str (),
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20726 diff changeset	1730 cname.c_str ());
a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20726 diff changeset	1731 }
a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20726 diff changeset	1732
21885 0806871e3e1e maint: Prefer is_empty() rather than "length () == 0". Rik <rik@octave.org> parents: 21782 diff changeset	1733 if (result.empty ())
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1734 error ("conversion from %s to %s failed", dtype.c_str (),
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1735 cname.c_str ());
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	1736
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	1737 retval = result(0);
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1738 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1739 else
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1740 {
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1741 // No conversion function available. Try the constructor for the
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1742 // dispatch type.
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1743
23599 5cb3a2bb5e1e don't use singleton for symbol_table John W. Eaton <jwe@octave.org> parents: 23592 diff changeset	1744 fcn = symtab.find_method (dtype, dtype);
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1745
20962 3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20955 diff changeset	1746 if (! fcn.is_defined ())
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20955 diff changeset	1747 error ("no constructor for %s!", dtype.c_str ());
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20955 diff changeset	1748
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20955 diff changeset	1749 octave_value_list result;
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20955 diff changeset	1750
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20955 diff changeset	1751 try
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1752 {
31730 610a85b0ff62 use interpreter::feval instead of global feval function John W. Eaton <jwe@octave.org> parents: 31707 diff changeset	1753 result = interp.feval (fcn, ovl (ov), 1);
20962 3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20955 diff changeset	1754 }
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	1755 catch (execution_exception& ee)
20962 3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20955 diff changeset	1756 {
29163 8f67ad8b3103 maint: Updating naming conventions for exceptions and use const where possible. Rik <rik@octave.org> parents: 29117 diff changeset	1757 error (ee, "%s constructor failed for %s argument", dtype.c_str (),
20962 3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20955 diff changeset	1758 cname.c_str ());
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1759 }
20962 3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20955 diff changeset	1760
21885 0806871e3e1e maint: Prefer is_empty() rather than "length () == 0". Rik <rik@octave.org> parents: 21782 diff changeset	1761 if (result.empty ())
20962 3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20955 diff changeset	1762 error ("%s constructor failed for %s argument", dtype.c_str (),
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20955 diff changeset	1763 cname.c_str ());
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	1764
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	1765 retval = result(0);
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1766 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1767
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1768 return retval;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1769 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1770
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1771 octave_value
29959 9e35973fb6c0 * data.h, data.cc (do_class_concat): Pass string argument by const reference. John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	1772 do_class_concat (const octave_value_list& ovl,
9e35973fb6c0 * data.h, data.cc (do_class_concat): Pass string argument by const reference. John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	1773 const std::string& cattype, int dim)
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1774 {
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1775 octave_value retval;
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1776
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1777 // Get dominant type for list
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1778
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	1779 std::string dtype = get_dispatch_type (ovl);
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	1780
31730 610a85b0ff62 use interpreter::feval instead of global feval function John W. Eaton <jwe@octave.org> parents: 31707 diff changeset	1781 interpreter& interp = __get_interpreter__ ();
610a85b0ff62 use interpreter::feval instead of global feval function John W. Eaton <jwe@octave.org> parents: 31707 diff changeset	1782
610a85b0ff62 use interpreter::feval instead of global feval function John W. Eaton <jwe@octave.org> parents: 31707 diff changeset	1783 symbol_table& symtab = interp.get_symbol_table ();
23599 5cb3a2bb5e1e don't use singleton for symbol_table John W. Eaton <jwe@octave.org> parents: 23592 diff changeset	1784
5cb3a2bb5e1e don't use singleton for symbol_table John W. Eaton <jwe@octave.org> parents: 23592 diff changeset	1785 octave_value fcn = symtab.find_method (cattype, dtype);
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1786
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1787 if (fcn.is_defined ())
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1788 {
20726 25d676f9619c Preface error() messages with name of function when possible. Rik <rik@octave.org> parents: 20720 diff changeset	1789 // Have method for dominant type. Call it and let it handle conversions.
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1790
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20726 diff changeset	1791 octave_value_list tmp2;
a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20726 diff changeset	1792
a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20726 diff changeset	1793 try
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1794 {
31730 610a85b0ff62 use interpreter::feval instead of global feval function John W. Eaton <jwe@octave.org> parents: 31707 diff changeset	1795 tmp2 = interp.feval (fcn, ovl, 1);
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20726 diff changeset	1796 }
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	1797 catch (execution_exception& ee)
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20726 diff changeset	1798 {
29163 8f67ad8b3103 maint: Updating naming conventions for exceptions and use const where possible. Rik <rik@octave.org> parents: 29117 diff changeset	1799 error (ee, "%s/%s method failed", dtype.c_str (), cattype.c_str ());
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1800 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1801
21885 0806871e3e1e maint: Prefer is_empty() rather than "length () == 0". Rik <rik@octave.org> parents: 21782 diff changeset	1802 if (tmp2.empty ())
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20726 diff changeset	1803 error ("%s/%s method did not return a value", dtype.c_str (),
a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20726 diff changeset	1804 cattype.c_str ());
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	1805
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	1806 retval = tmp2(0);
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1807 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1808 else
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1809 {
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1810 // No method for dominant type, so attempt type conversions for
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1811 // all elements that are not of the dominant type, then do the
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1812 // default operation for octave_class values.
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1813
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1814 octave_idx_type j = 0;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1815 octave_idx_type len = ovl.length ();
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1816 octave_value_list tmp (len, octave_value ());
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1817 for (octave_idx_type k = 0; k < len; k++)
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1818 {
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1819 octave_value elt = ovl(k);
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1820
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1821 std::string t1_type = elt.class_name ();
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1822
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1823 if (t1_type == dtype)
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1824 tmp(j++) = elt;
23587 0c468af9dc00 maint: Deprecate is_object and replace with isobject. Rik <rik@octave.org> parents: 23586 diff changeset	1825 else if (elt.isobject () \|\| ! elt.isempty ())
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	1826 tmp(j++) = attempt_type_conversion (elt, dtype);
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1827 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1828
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1829 tmp.resize (j);
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1830
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1831 octave_map m = do_single_type_concat_map (tmp, dim);
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1832
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1833 std::string cname = tmp(0).class_name ();
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1834 std::list<std::string> parents = tmp(0).parent_class_name_list ();
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1835
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1836 retval = octave_value (new octave_class (m, cname, parents));
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1837 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1838
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1839 return retval;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1840 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1841
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1842 static octave_value
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1843 do_cat (const octave_value_list& xargs, int dim, std::string fname)
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1844 {
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1845 octave_value retval;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1846
20811 5979314bb15a Fix BIST tests for rows. Rik <rik@octave.org> parents: 20810 diff changeset	1847 // We may need to convert elements of the list to cells, so make a copy.
5979314bb15a Fix BIST tests for rows. Rik <rik@octave.org> parents: 20810 diff changeset	1848 // This should be efficient, it is done mostly by incrementing reference
5979314bb15a Fix BIST tests for rows. Rik <rik@octave.org> parents: 20810 diff changeset	1849 // counts.
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1850 octave_value_list args = xargs;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1851
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1852 int n_args = args.length ();
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1853
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1854 if (n_args == 0)
5714 24f6a13878c2 [project @ 2006-03-23 21:46:09 by jwe] jwe parents: 5677 diff changeset	1855 retval = Matrix ();
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1856 else if (n_args == 1)
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1857 retval = args(0);
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1858 else if (n_args > 1)
4824 4829055e154f [project @ 2004-03-08 18:16:04 by jwe] jwe parents: 4806 diff changeset	1859 {
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1860 std::string result_type;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1861
19399 2304ddfd736f Restore warning Octave:num-to-str missing since 3.2.4 (bug #43814). Rik <rik@octave.org> parents: 18869 diff changeset	1862 bool all_strings_p = true;
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1863 bool all_sq_strings_p = true;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1864 bool all_dq_strings_p = true;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1865 bool all_real_p = true;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1866 bool all_cmplx_p = true;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1867 bool any_sparse_p = false;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1868 bool any_cell_p = false;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1869 bool any_class_p = false;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1870
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1871 bool first_elem_is_struct = false;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1872
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1873 for (int i = 0; i < n_args; i++)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1874 {
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1875 if (i == 0)
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1876 {
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1877 result_type = args(i).class_name ();
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1878
23584 7ed6b258db91 maint: Deprecate is_map and replace with isstruct. Rik <rik@octave.org> parents: 23583 diff changeset	1879 first_elem_is_struct = args(i).isstruct ();
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1880 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1881 else
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	1882 result_type = get_concat_class (result_type, args(i).class_name ());
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1883
19399 2304ddfd736f Restore warning Octave:num-to-str missing since 3.2.4 (bug #43814). Rik <rik@octave.org> parents: 18869 diff changeset	1884 if (all_strings_p && ! args(i).is_string ())
2304ddfd736f Restore warning Octave:num-to-str missing since 3.2.4 (bug #43814). Rik <rik@octave.org> parents: 18869 diff changeset	1885 all_strings_p = false;
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1886 if (all_sq_strings_p && ! args(i).is_sq_string ())
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1887 all_sq_strings_p = false;
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1888 if (all_dq_strings_p && ! args(i).is_dq_string ())
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1889 all_dq_strings_p = false;
23582 0cc2011d800e maint: Deprecate is_real_type and replace with isreal. Rik <rik@octave.org> parents: 23581 diff changeset	1890 if (all_real_p && ! args(i).isreal ())
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1891 all_real_p = false;
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	1892 if (all_cmplx_p && ! (args(i).iscomplex ()
23582 0cc2011d800e maint: Deprecate is_real_type and replace with isreal. Rik <rik@octave.org> parents: 23581 diff changeset	1893 \|\| args(i).isreal ()))
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1894 all_cmplx_p = false;
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	1895 if (! any_sparse_p && args(i).issparse ())
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1896 any_sparse_p = true;
23576 00e518162fda maint: Deprecate is_cell and replace with iscell. Rik <rik@octave.org> parents: 23575 diff changeset	1897 if (! any_cell_p && args(i).iscell ())
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1898 any_cell_p = true;
23587 0c468af9dc00 maint: Deprecate is_object and replace with isobject. Rik <rik@octave.org> parents: 23586 diff changeset	1899 if (! any_class_p && args(i).isobject ())
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1900 any_class_p = true;
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1901 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1902
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1903 if (any_cell_p && ! any_class_p && ! first_elem_is_struct)
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1904 {
22895 0ab9eecbb165 Concatenate empty matrices/cells in cat() the same as the parser (bug #49759). Rik <rik@octave.org> parents: 22853 diff changeset	1905 int j = 0;
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1906 for (int i = 0; i < n_args; i++)
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1907 {
23576 00e518162fda maint: Deprecate is_cell and replace with iscell. Rik <rik@octave.org> parents: 23575 diff changeset	1908 if (args(i).iscell ())
22895 0ab9eecbb165 Concatenate empty matrices/cells in cat() the same as the parser (bug #49759). Rik <rik@octave.org> parents: 22853 diff changeset	1909 args(j++) = args(i);
0ab9eecbb165 Concatenate empty matrices/cells in cat() the same as the parser (bug #49759). Rik <rik@octave.org> parents: 22853 diff changeset	1910 else
0ab9eecbb165 Concatenate empty matrices/cells in cat() the same as the parser (bug #49759). Rik <rik@octave.org> parents: 22853 diff changeset	1911 {
23577 80c42f4cca13 maint: Deprecate is_empty and replace with isempty. Rik <rik@octave.org> parents: 23576 diff changeset	1912 if (args(i).isempty ())
22895 0ab9eecbb165 Concatenate empty matrices/cells in cat() the same as the parser (bug #49759). Rik <rik@octave.org> parents: 22853 diff changeset	1913 continue; // Delete empty non-cell arg
0ab9eecbb165 Concatenate empty matrices/cells in cat() the same as the parser (bug #49759). Rik <rik@octave.org> parents: 22853 diff changeset	1914 else
0ab9eecbb165 Concatenate empty matrices/cells in cat() the same as the parser (bug #49759). Rik <rik@octave.org> parents: 22853 diff changeset	1915 args(j++) = Cell (args(i));
0ab9eecbb165 Concatenate empty matrices/cells in cat() the same as the parser (bug #49759). Rik <rik@octave.org> parents: 22853 diff changeset	1916 }
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1917 }
22895 0ab9eecbb165 Concatenate empty matrices/cells in cat() the same as the parser (bug #49759). Rik <rik@octave.org> parents: 22853 diff changeset	1918 n_args = j;
0ab9eecbb165 Concatenate empty matrices/cells in cat() the same as the parser (bug #49759). Rik <rik@octave.org> parents: 22853 diff changeset	1919 args.resize (n_args);
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1920 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1921
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1922 if (any_class_p)
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1923 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	1924 retval = do_class_concat (args, fname, dim);
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1925 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1926 else if (result_type == "double")
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1927 {
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1928 if (any_sparse_p)
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1929 {
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1930 if (all_real_p)
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1931 retval = do_single_type_concat<SparseMatrix> (args, dim);
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1932 else
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1933 retval = do_single_type_concat<SparseComplexMatrix> (args, dim);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1934 }
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1935 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1936 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1937 if (all_real_p)
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1938 retval = do_single_type_concat<NDArray> (args, dim);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1939 else
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1940 retval = do_single_type_concat<ComplexNDArray> (args, dim);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1941 }
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1942 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1943 else if (result_type == "single")
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1944 {
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1945 if (all_real_p)
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1946 retval = do_single_type_concat<FloatNDArray> (args, dim);
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1947 else
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1948 retval = do_single_type_concat<FloatComplexNDArray> (args, dim);
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1949 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1950 else if (result_type == "char")
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1951 {
23450 855122b993da maint: Wrap tertiary operator in parentheses "(COND ? x : y)". Rik <rik@octave.org> parents: 23449 diff changeset	1952 char type = (all_dq_strings_p ? '"' : '\'');
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1953
19399 2304ddfd736f Restore warning Octave:num-to-str missing since 3.2.4 (bug #43814). Rik <rik@octave.org> parents: 18869 diff changeset	1954 if (! all_strings_p)
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21078 diff changeset	1955 warn_implicit_conversion ("Octave:num-to-str",
e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21078 diff changeset	1956 "numeric", result_type);
19399 2304ddfd736f Restore warning Octave:num-to-str missing since 3.2.4 (bug #43814). Rik <rik@octave.org> parents: 18869 diff changeset	1957 else
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	1958 maybe_warn_string_concat (all_dq_strings_p, all_sq_strings_p);
19399 2304ddfd736f Restore warning Octave:num-to-str missing since 3.2.4 (bug #43814). Rik <rik@octave.org> parents: 18869 diff changeset	1959
2304ddfd736f Restore warning Octave:num-to-str missing since 3.2.4 (bug #43814). Rik <rik@octave.org> parents: 18869 diff changeset	1960 charNDArray result = do_single_type_concat<charNDArray> (args, dim);
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1961
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1962 retval = octave_value (result, type);
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1963 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1964 else if (result_type == "logical")
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1965 {
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1966 if (any_sparse_p)
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1967 retval = do_single_type_concat<SparseBoolMatrix> (args, dim);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1968 else
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1969 retval = do_single_type_concat<boolNDArray> (args, dim);
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1970 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1971 else if (result_type == "int8")
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1972 retval = do_single_type_concat<int8NDArray> (args, dim);
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1973 else if (result_type == "int16")
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1974 retval = do_single_type_concat<int16NDArray> (args, dim);
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1975 else if (result_type == "int32")
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1976 retval = do_single_type_concat<int32NDArray> (args, dim);
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1977 else if (result_type == "int64")
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1978 retval = do_single_type_concat<int64NDArray> (args, dim);
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1979 else if (result_type == "uint8")
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1980 retval = do_single_type_concat<uint8NDArray> (args, dim);
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1981 else if (result_type == "uint16")
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1982 retval = do_single_type_concat<uint16NDArray> (args, dim);
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1983 else if (result_type == "uint32")
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1984 retval = do_single_type_concat<uint32NDArray> (args, dim);
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1985 else if (result_type == "uint64")
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1986 retval = do_single_type_concat<uint64NDArray> (args, dim);
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1987 else if (result_type == "cell")
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1988 retval = do_single_type_concat<Cell> (args, dim);
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1989 else if (result_type == "struct")
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1990 retval = do_single_type_concat_map (args, dim);
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1991 else
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1992 {
20218 b2100e1659ac maint: Use cuddled parentheses when indexing dimension_vectors. Rik <rik@octave.org> parents: 20183 diff changeset	1993 dim_vector dv = args(0).dims ();
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1994
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1995 // Default concatenation.
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1996 bool (dim_vector::*concat_rule) (const dim_vector&, int)
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1997 = &dim_vector::concat;
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1998
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1999 if (dim == -1 \|\| dim == -2)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2000 {
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2001 concat_rule = &dim_vector::hvcat;
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2002 dim = -dim - 1;
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2003 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2004
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2005 for (int i = 1; i < args.length (); i++)
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2006 {
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2007 if (! (dv.*concat_rule) (args(i).dims (), dim))
20893 384ff5aa9437 2015 Code Sprint: Eliminate useless return statements after error (). Rik <rik@octave.org> parents: 20884 diff changeset	2008 error ("cat: dimension mismatch");
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2009 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2010
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2011 // The lines below might seem crazy, since we take a copy
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2012 // of the first argument, resize it to be empty and then resize
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21730 diff changeset	2013 // it to be full. This is done since it means that there is no
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2014 // recopying of data, as would happen if we used a single resize.
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	2015 // It should be noted that resize operation is also significantly
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2016 // slower than the do_cat_op function, so it makes sense to have
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2017 // an empty matrix and copy all data.
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2018 //
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2019 // We might also start with a empty octave_value using
24540 46440078d73b don't use singleton for octave_value_typeinfo John W. Eaton <jwe@octave.org> parents: 24536 diff changeset	2020 //
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	2021 // tmp = type_info::lookup_type (args(1).type_name());
24540 46440078d73b don't use singleton for octave_value_typeinfo John W. Eaton <jwe@octave.org> parents: 24536 diff changeset	2022 //
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21730 diff changeset	2023 // and then directly resize. However, for some types there might
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2024 // be some additional setup needed, and so this should be avoided.
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2025
18112 b560bac0fca2 maint: Don't use space between 'args' and '(' when doing indexing. Rik <rik@octave.org> parents: 18100 diff changeset	2026 octave_value tmp = args(0);
30390 a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30377 diff changeset	2027 tmp = tmp.resize (dim_vector (0, 0)).resize (dv);
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2028
21660 53728df3e4c9 maint: for clarity, call ndims() rather than length() on dimension vectors. Rik <rik@octave.org> parents: 21602 diff changeset	2029 int dv_len = dv.ndims ();
11570 57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	2030 Array<octave_idx_type> ra_idx (dim_vector (dv_len, 1), 0);
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2031
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2032 for (int j = 0; j < n_args; j++)
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2033 {
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2034 // Can't fast return here to skip empty matrices as something
14861 f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory Rik <octave@nomad.inbox5.com> parents: 14853 diff changeset	2035 // like cat (1,[],single ([])) must return an empty matrix of
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2036 // the right type.
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	2037 tmp = cat_op (tmp, args(j), ra_idx);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2038
32598 2f3b54f81947 avoid dim_vector copies in more places where possible (bug #64962) John W. Eaton <jwe@octave.org> parents: 32585 diff changeset	2039 const dim_vector& dv_tmp = args(j).dims ();
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2040
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2041 if (dim >= dv_len)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2042 {
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2043 if (j > 1)
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2044 error ("%s: indexing error", fname.c_str ());
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	2045
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2046 break;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2047 }
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2048 else
21660 53728df3e4c9 maint: for clarity, call ndims() rather than length() on dimension vectors. Rik <rik@octave.org> parents: 21602 diff changeset	2049 ra_idx(dim) += (dim < dv_tmp.ndims () ? dv_tmp(dim) : 1);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2050 }
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2051 retval = tmp;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2052 }
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2053 }
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2054 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2055 print_usage ();
8113 38a797766a2a Special case single type conacation in Fcat. Rework cell2mat to take advantage David Bateman <dbateman@free.fr> parents: 8111 diff changeset	2056
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2057 return retval;
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2058 }
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2059
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2060 DEFUN (horzcat, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2061 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2062 @deftypefn {} {@var{A} =} horzcat (@var{array1}, @var{array2}, @dots{}, @var{arrayN})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2063 Return the horizontal concatenation of N-D array objects, @var{array1},
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2064 @var{array2}, @dots{}, @var{arrayN} along dimension 2.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2065
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2066 Arrays may also be concatenated horizontally using the syntax for creating
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2067 new matrices. For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2068
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2069 @example
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2070 @var{A} = [ @var{array1}, @var{array2}, @dots{} ]
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2071 @end example
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2072
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2073 This syntax is slightly more efficient because the Octave parser can
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2074 concatenate the arrays without the overhead of a function call.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2075 @seealso{cat, vertcat}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2076 @end deftypefn */)
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2077 {
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2078 return do_cat (args, -2, "horzcat");
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2079 }
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2080
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2081 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2082 ## Test concatenation with all zero matrices
21575 bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2083 %!test
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2084 %! warning ("off", "Octave:num-to-str", "local");
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	2085 %! assert (horzcat ("", 65* ones (1,10)), "AAAAAAAAAA");
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	2086 %! assert (horzcat (65* ones (1,10), ""), "AAAAAAAAAA");
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2087
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2088 %!assert (class (horzcat (int64 (1), int64 (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2089 %!assert (class (horzcat (int64 (1), int32 (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2090 %!assert (class (horzcat (int64 (1), int16 (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2091 %!assert (class (horzcat (int64 (1), int8 (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2092 %!assert (class (horzcat (int64 (1), uint64 (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2093 %!assert (class (horzcat (int64 (1), uint32 (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2094 %!assert (class (horzcat (int64 (1), uint16 (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2095 %!assert (class (horzcat (int64 (1), uint8 (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2096 %!assert (class (horzcat (int64 (1), single (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2097 %!assert (class (horzcat (int64 (1), double (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2098 %!assert (class (horzcat (int64 (1), cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2099 %!assert (class (horzcat (int64 (1), true)), "int64")
21575 bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2100 %!test
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2101 %! warning ("off", "Octave:num-to-str", "local");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2102 %! assert (class (horzcat (int64 (1), "a")), "char");
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2103
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2104 %!assert (class (horzcat (int32 (1), int64 (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2105 %!assert (class (horzcat (int32 (1), int32 (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2106 %!assert (class (horzcat (int32 (1), int16 (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2107 %!assert (class (horzcat (int32 (1), int8 (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2108 %!assert (class (horzcat (int32 (1), uint64 (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2109 %!assert (class (horzcat (int32 (1), uint32 (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2110 %!assert (class (horzcat (int32 (1), uint16 (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2111 %!assert (class (horzcat (int32 (1), uint8 (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2112 %!assert (class (horzcat (int32 (1), single (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2113 %!assert (class (horzcat (int32 (1), double (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2114 %!assert (class (horzcat (int32 (1), cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2115 %!assert (class (horzcat (int32 (1), true)), "int32")
21575 bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2116 %!test
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2117 %! warning ("off", "Octave:num-to-str", "local");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2118 %! assert (class (horzcat (int32 (1), "a")), "char");
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2119
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2120 %!assert (class (horzcat (int16 (1), int64 (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2121 %!assert (class (horzcat (int16 (1), int32 (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2122 %!assert (class (horzcat (int16 (1), int16 (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2123 %!assert (class (horzcat (int16 (1), int8 (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2124 %!assert (class (horzcat (int16 (1), uint64 (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2125 %!assert (class (horzcat (int16 (1), uint32 (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2126 %!assert (class (horzcat (int16 (1), uint16 (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2127 %!assert (class (horzcat (int16 (1), uint8 (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2128 %!assert (class (horzcat (int16 (1), single (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2129 %!assert (class (horzcat (int16 (1), double (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2130 %!assert (class (horzcat (int16 (1), cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2131 %!assert (class (horzcat (int16 (1), true)), "int16")
21575 bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2132 %!test
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2133 %! warning ("off", "Octave:num-to-str", "local");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2134 %! assert (class (horzcat (int16 (1), "a")), "char");
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2135
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2136 %!assert (class (horzcat (int8 (1), int64 (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2137 %!assert (class (horzcat (int8 (1), int32 (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2138 %!assert (class (horzcat (int8 (1), int16 (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2139 %!assert (class (horzcat (int8 (1), int8 (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2140 %!assert (class (horzcat (int8 (1), uint64 (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2141 %!assert (class (horzcat (int8 (1), uint32 (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2142 %!assert (class (horzcat (int8 (1), uint16 (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2143 %!assert (class (horzcat (int8 (1), uint8 (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2144 %!assert (class (horzcat (int8 (1), single (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2145 %!assert (class (horzcat (int8 (1), double (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2146 %!assert (class (horzcat (int8 (1), cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2147 %!assert (class (horzcat (int8 (1), true)), "int8")
21575 bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2148 %!test
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2149 %! warning ("off", "Octave:num-to-str", "local");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2150 %! assert (class (horzcat (int8 (1), "a")), "char");
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2151
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2152 %!assert (class (horzcat (uint64 (1), int64 (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2153 %!assert (class (horzcat (uint64 (1), int32 (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2154 %!assert (class (horzcat (uint64 (1), int16 (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2155 %!assert (class (horzcat (uint64 (1), int8 (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2156 %!assert (class (horzcat (uint64 (1), uint64 (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2157 %!assert (class (horzcat (uint64 (1), uint32 (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2158 %!assert (class (horzcat (uint64 (1), uint16 (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2159 %!assert (class (horzcat (uint64 (1), uint8 (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2160 %!assert (class (horzcat (uint64 (1), single (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2161 %!assert (class (horzcat (uint64 (1), double (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2162 %!assert (class (horzcat (uint64 (1), cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2163 %!assert (class (horzcat (uint64 (1), true)), "uint64")
21575 bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2164 %!test
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2165 %! warning ("off", "Octave:num-to-str", "local");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2166 %! assert (class (horzcat (uint64 (1), "a")), "char");
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2167
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2168 %!assert (class (horzcat (uint32 (1), int64 (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2169 %!assert (class (horzcat (uint32 (1), int32 (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2170 %!assert (class (horzcat (uint32 (1), int16 (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2171 %!assert (class (horzcat (uint32 (1), int8 (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2172 %!assert (class (horzcat (uint32 (1), uint64 (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2173 %!assert (class (horzcat (uint32 (1), uint32 (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2174 %!assert (class (horzcat (uint32 (1), uint16 (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2175 %!assert (class (horzcat (uint32 (1), uint8 (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2176 %!assert (class (horzcat (uint32 (1), single (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2177 %!assert (class (horzcat (uint32 (1), double (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2178 %!assert (class (horzcat (uint32 (1), cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2179 %!assert (class (horzcat (uint32 (1), true)), "uint32")
21575 bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2180 %!test
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2181 %! warning ("off", "Octave:num-to-str", "local");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2182 %! assert (class (horzcat (uint32 (1), "a")), "char");
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2183
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2184 %!assert (class (horzcat (uint16 (1), int64 (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2185 %!assert (class (horzcat (uint16 (1), int32 (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2186 %!assert (class (horzcat (uint16 (1), int16 (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2187 %!assert (class (horzcat (uint16 (1), int8 (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2188 %!assert (class (horzcat (uint16 (1), uint64 (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2189 %!assert (class (horzcat (uint16 (1), uint32 (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2190 %!assert (class (horzcat (uint16 (1), uint16 (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2191 %!assert (class (horzcat (uint16 (1), uint8 (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2192 %!assert (class (horzcat (uint16 (1), single (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2193 %!assert (class (horzcat (uint16 (1), double (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2194 %!assert (class (horzcat (uint16 (1), cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2195 %!assert (class (horzcat (uint16 (1), true)), "uint16")
21575 bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2196 %!test
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2197 %! warning ("off", "Octave:num-to-str", "local");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2198 %! assert (class (horzcat (uint16 (1), "a")), "char");
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2199
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2200 %!assert (class (horzcat (uint8 (1), int64 (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2201 %!assert (class (horzcat (uint8 (1), int32 (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2202 %!assert (class (horzcat (uint8 (1), int16 (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2203 %!assert (class (horzcat (uint8 (1), int8 (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2204 %!assert (class (horzcat (uint8 (1), uint64 (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2205 %!assert (class (horzcat (uint8 (1), uint32 (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2206 %!assert (class (horzcat (uint8 (1), uint16 (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2207 %!assert (class (horzcat (uint8 (1), uint8 (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2208 %!assert (class (horzcat (uint8 (1), single (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2209 %!assert (class (horzcat (uint8 (1), double (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2210 %!assert (class (horzcat (uint8 (1), cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2211 %!assert (class (horzcat (uint8 (1), true)), "uint8")
21575 bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2212 %!test
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2213 %! warning ("off", "Octave:num-to-str", "local");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2214 %! assert (class (horzcat (uint8 (1), "a")), "char");
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2215
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2216 %!assert (class (horzcat (single (1), int64 (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2217 %!assert (class (horzcat (single (1), int32 (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2218 %!assert (class (horzcat (single (1), int16 (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2219 %!assert (class (horzcat (single (1), int8 (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2220 %!assert (class (horzcat (single (1), uint64 (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2221 %!assert (class (horzcat (single (1), uint32 (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2222 %!assert (class (horzcat (single (1), uint16 (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2223 %!assert (class (horzcat (single (1), uint8 (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2224 %!assert (class (horzcat (single (1), single (1))), "single")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2225 %!assert (class (horzcat (single (1), double (1))), "single")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2226 %!assert (class (horzcat (single (1), cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2227 %!assert (class (horzcat (single (1), true)), "single")
21575 bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2228 %!test
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2229 %! warning ("off", "Octave:num-to-str", "local");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2230 %! assert (class (horzcat (single (1), "a")), "char");
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2231
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2232 %!assert (class (horzcat (double (1), int64 (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2233 %!assert (class (horzcat (double (1), int32 (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2234 %!assert (class (horzcat (double (1), int16 (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2235 %!assert (class (horzcat (double (1), int8 (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2236 %!assert (class (horzcat (double (1), uint64 (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2237 %!assert (class (horzcat (double (1), uint32 (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2238 %!assert (class (horzcat (double (1), uint16 (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2239 %!assert (class (horzcat (double (1), uint8 (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2240 %!assert (class (horzcat (double (1), single (1))), "single")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2241 %!assert (class (horzcat (double (1), double (1))), "double")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2242 %!assert (class (horzcat (double (1), cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2243 %!assert (class (horzcat (double (1), true)), "double")
21575 bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2244 %!test
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2245 %! warning ("off", "Octave:num-to-str", "local");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2246 %! assert (class (horzcat (double (1), "a")), "char");
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2247
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2248 %!assert (class (horzcat (cell (1), int64 (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2249 %!assert (class (horzcat (cell (1), int32 (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2250 %!assert (class (horzcat (cell (1), int16 (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2251 %!assert (class (horzcat (cell (1), int8 (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2252 %!assert (class (horzcat (cell (1), uint64 (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2253 %!assert (class (horzcat (cell (1), uint32 (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2254 %!assert (class (horzcat (cell (1), uint16 (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2255 %!assert (class (horzcat (cell (1), uint8 (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2256 %!assert (class (horzcat (cell (1), single (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2257 %!assert (class (horzcat (cell (1), double (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2258 %!assert (class (horzcat (cell (1), cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2259 %!assert (class (horzcat (cell (1), true)), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2260 %!assert (class (horzcat (cell (1), "a")), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2261
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2262 %!assert (class (horzcat (true, int64 (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2263 %!assert (class (horzcat (true, int32 (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2264 %!assert (class (horzcat (true, int16 (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2265 %!assert (class (horzcat (true, int8 (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2266 %!assert (class (horzcat (true, uint64 (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2267 %!assert (class (horzcat (true, uint32 (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2268 %!assert (class (horzcat (true, uint16 (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2269 %!assert (class (horzcat (true, uint8 (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2270 %!assert (class (horzcat (true, single (1))), "single")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2271 %!assert (class (horzcat (true, double (1))), "double")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2272 %!assert (class (horzcat (true, cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2273 %!assert (class (horzcat (true, true)), "logical")
21575 bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2274 %!test
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2275 %! warning ("off", "Octave:num-to-str", "local");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2276 %! assert (class (horzcat (true, "a")), "char");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2277
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2278 %!test
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2279 %! warning ("off", "Octave:num-to-str", "local");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2280 %! assert (class (horzcat ("a", int64 (1))), "char");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2281 %! assert (class (horzcat ("a", int32 (1))), "char");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2282 %! assert (class (horzcat ("a", int16 (1))), "char");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2283 %! assert (class (horzcat ("a", int8 (1))), "char");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2284 %! assert (class (horzcat ("a", int64 (1))), "char");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2285 %! assert (class (horzcat ("a", int32 (1))), "char");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2286 %! assert (class (horzcat ("a", int16 (1))), "char");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2287 %! assert (class (horzcat ("a", int8 (1))), "char");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2288 %! assert (class (horzcat ("a", single (1))), "char");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2289 %! assert (class (horzcat ("a", double (1))), "char");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2290 %! assert (class (horzcat ("a", cell (1))), "cell");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2291 %! assert (class (horzcat ("a", true)), "char");
bc9aa534bc29 maint: Clean up BIST tests so they don't produce warnings. Rik <rik@octave.org> parents: 21547 diff changeset	2292 %! assert (class (horzcat ("a", "a")), "char");
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2293
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2294 %!assert (class (horzcat (cell (1), struct ("foo", "bar"))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2295
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2296 %!error horzcat (struct ("foo", "bar"), cell (1))
23515 4d7928872999 Fix concatenation of a struct with an empty cell array (bug #39041) Mike Miller <mtmiller@octave.org> parents: 23473 diff changeset	2297
28915 c40a367a84c0 maint: Use Octave convention of space after function name in libinterp/. Rik <rik@octave.org> parents: 28888 diff changeset	2298 %!test <*39041> assert (class (horzcat (cell (0), struct ())), "cell")
c40a367a84c0 maint: Use Octave convention of space after function name in libinterp/. Rik <rik@octave.org> parents: 28888 diff changeset	2299 %!test <51086> assert (class (horzcat (struct (), cell (0))), "struct")
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2300 */
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2301
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2302 DEFUN (vertcat, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2303 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2304 @deftypefn {} {@var{A} =} vertcat (@var{array1}, @var{array2}, @dots{}, @var{arrayN})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2305 Return the vertical concatenation of N-D array objects, @var{array1},
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2306 @var{array2}, @dots{}, @var{arrayN} along dimension 1.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2307
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2308 Arrays may also be concatenated vertically using the syntax for creating
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2309 new matrices. For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2310
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2311 @example
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2312 @var{A} = [ @var{array1}; @var{array2}; @dots{} ]
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2313 @end example
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2314
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2315 This syntax is slightly more efficient because the Octave parser can
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2316 concatenate the arrays without the overhead of a function call.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2317 @seealso{cat, horzcat}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2318 @end deftypefn */)
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2319 {
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2320 return do_cat (args, -1, "vertcat");
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2321 }
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2322
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2323 /*
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2324 %!test
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2325 %! c = {"foo"; "bar"; "bazoloa"};
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2326 %! assert (vertcat (c, "a", "bc", "def"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2327 %! {"foo"; "bar"; "bazoloa"; "a"; "bc"; "def"});
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2328 */
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2329
4758 a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2330 DEFUN (cat, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2331 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2332 @deftypefn {} {@var{A} =} cat (@var{dim}, @var{array1}, @var{array2}, @dots{}, @var{arrayN})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2333 Return the concatenation of N-D array objects, @var{array1}, @var{array2},
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2334 @dots{}, @var{arrayN} along dimension @var{dim}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2335
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2336 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2337 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2338 A = ones (2, 2);
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2339 B = zeros (2, 2);
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2340 cat (2, A, B)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2341 @result{} 1 1 0 0
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2342 1 1 0 0
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2343 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2344 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2345
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2346 Alternatively, we can concatenate @var{A} and @var{B} along the second
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2347 dimension in the following way:
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2348
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2349 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2350 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2351 [A, B]
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2352 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2353 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2354
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2355 @var{dim} can be larger than the dimensions of the N-D array objects and the
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2356 result will thus have @var{dim} dimensions as the following example shows:
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2357
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2358 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2359 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2360 cat (4, ones (2, 2), zeros (2, 2))
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2361 @result{} ans(:,:,1,1) =
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2362
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2363 1 1
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2364 1 1
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2365
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2366 ans(:,:,1,2) =
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2367
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2368 0 0
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2369 0 0
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2370 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2371 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2372 @seealso{horzcat, vertcat}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2373 @end deftypefn */)
4758 a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2374 {
20850 b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	2375 if (args.length () == 0)
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2376 print_usage ();
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2377
33446 5fded8395daa rename yTYPE_value functions strict_TYPE_value John W. Eaton <jwe@octave.org> parents: 33382 diff changeset	2378 int dim = args(0).strict_int_value ("cat: DIM must be an integer") - 1;
20850 b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	2379
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	2380 if (dim < 0)
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	2381 error ("cat: DIM must be a valid dimension");
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	2382
21127 df7891224709 maint: Use "return ovl (...)" in DEFUN macros. Rik <rik@octave.org> parents: 21121 diff changeset	2383 return ovl (do_cat (args.slice (1, args.length () - 1), dim, "cat"));
4758 a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2384 }
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2385
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	2386 /*
14085 4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2387 %!function ret = __testcat (t1, t2, tr, cmplx)
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	2388 %! assert (cat (1, cast ([], t1), cast ([], t2)), cast ([], tr));
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2389 %!
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2390 %! assert (cat (1, cast (1, t1), cast (2, t2)), cast ([1; 2], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2391 %! assert (cat (1, cast (1, t1), cast ([2; 3], t2)), cast ([1; 2; 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2392 %! assert (cat (1, cast ([1; 2], t1), cast (3, t2)), cast ([1; 2; 3], tr));
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2393 %! assert (cat (1, cast ([1; 2], t1), cast ([3; 4], t2)),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2394 %! cast ([1; 2; 3; 4], tr));
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2395 %! assert (cat (2, cast (1, t1), cast (2, t2)), cast ([1, 2], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2396 %! assert (cat (2, cast (1, t1), cast ([2, 3], t2)), cast ([1, 2, 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2397 %! assert (cat (2, cast ([1, 2], t1), cast (3, t2)), cast ([1, 2, 3], tr));
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2398 %! assert (cat (2, cast ([1, 2], t1), cast ([3, 4], t2)),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2399 %! cast ([1, 2, 3, 4], tr));
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2400 %!
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2401 %! assert ([cast(1, t1); cast(2, t2)], cast ([1; 2], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2402 %! assert ([cast(1, t1); cast([2; 3], t2)], cast ([1; 2; 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2403 %! assert ([cast([1; 2], t1); cast(3, t2)], cast ([1; 2; 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2404 %! assert ([cast([1; 2], t1); cast([3; 4], t2)], cast ([1; 2; 3; 4], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2405 %! assert ([cast(1, t1), cast(2, t2)], cast ([1, 2], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2406 %! assert ([cast(1, t1), cast([2, 3], t2)], cast ([1, 2, 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2407 %! assert ([cast([1, 2], t1), cast(3, t2)], cast ([1, 2, 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2408 %! assert ([cast([1, 2], t1), cast([3, 4], t2)], cast ([1, 2, 3, 4], tr));
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2409 %!
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2410 %! if (nargin == 3 \|\| cmplx)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2411 %! assert (cat (1, cast (1i, t1), cast (2, t2)), cast ([1i; 2], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2412 %! assert (cat (1, cast (1i, t1), cast ([2; 3], t2)), cast ([1i; 2; 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2413 %! assert (cat (1, cast ([1i; 2], t1), cast (3, t2)), cast ([1i; 2; 3], tr));
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2414 %! assert (cat (1, cast ([1i; 2], t1), cast ([3; 4], t2)),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2415 %! cast ([1i; 2; 3; 4], tr));
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2416 %! assert (cat (2, cast (1i, t1), cast (2, t2)), cast ([1i, 2], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2417 %! assert (cat (2, cast (1i, t1), cast ([2, 3], t2)), cast ([1i, 2, 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2418 %! assert (cat (2, cast ([1i, 2], t1), cast (3, t2)), cast ([1i, 2, 3], tr));
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2419 %! assert (cat (2, cast ([1i, 2], t1), cast ([3, 4], t2)),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2420 %! cast ([1i, 2, 3, 4], tr));
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2421 %! assert ([cast(1i, t1); cast(2, t2)], cast ([1i; 2], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2422 %! assert ([cast(1i, t1); cast([2; 3], t2)], cast ([1i; 2; 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2423 %! assert ([cast([1i; 2], t1); cast(3, t2)], cast ([1i; 2; 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2424 %! assert ([cast([1i; 2], t1); cast([3; 4], t2)], cast ([1i; 2; 3; 4], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2425 %! assert ([cast(1i, t1), cast(2, t2)], cast ([1i, 2], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2426 %! assert ([cast(1i, t1), cast([2, 3], t2)], cast ([1i, 2, 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2427 %! assert ([cast([1i, 2], t1), cast(3, t2)], cast ([1i, 2, 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2428 %! assert ([cast([1i, 2], t1), cast([3, 4], t2)], cast ([1i, 2, 3, 4], tr));
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2429 %!
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2430 %! assert (cat (1, cast (1, t1), cast (2i, t2)), cast ([1; 2i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2431 %! assert (cat (1, cast (1, t1), cast ([2i; 3], t2)), cast ([1; 2i; 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2432 %! assert (cat (1, cast ([1; 2], t1), cast (3i, t2)), cast ([1; 2; 3i], tr));
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2433 %! assert (cat (1, cast ([1; 2], t1), cast ([3i; 4], t2)),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2434 %! cast ([1; 2; 3i; 4], tr));
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2435 %! assert (cat (2, cast (1, t1), cast (2i, t2)), cast ([1, 2i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2436 %! assert (cat (2, cast (1, t1), cast ([2i, 3], t2)), cast ([1, 2i, 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2437 %! assert (cat (2, cast ([1, 2], t1), cast (3i, t2)), cast ([1, 2, 3i], tr));
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2438 %! assert (cat (2, cast ([1, 2], t1), cast ([3i, 4], t2)),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2439 %! cast ([1, 2, 3i, 4], tr));
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2440 %! assert ([cast(1, t1); cast(2i, t2)], cast ([1; 2i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2441 %! assert ([cast(1, t1); cast([2i; 3], t2)], cast ([1; 2i; 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2442 %! assert ([cast([1; 2], t1); cast(3i, t2)], cast ([1; 2; 3i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2443 %! assert ([cast([1; 2], t1); cast([3i; 4], t2)], cast ([1; 2; 3i; 4], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2444 %! assert ([cast(1, t1), cast(2i, t2)], cast ([1, 2i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2445 %! assert ([cast(1, t1), cast([2i, 3], t2)], cast ([1, 2i, 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2446 %! assert ([cast([1, 2], t1), cast(3i, t2)], cast ([1, 2, 3i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2447 %! assert ([cast([1, 2], t1), cast([3i, 4], t2)], cast ([1, 2, 3i, 4], tr));
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2448 %!
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2449 %! assert (cat (1, cast (1i, t1), cast (2i, t2)), cast ([1i; 2i], tr));
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2450 %! assert (cat (1, cast (1i, t1), cast ([2i; 3], t2)),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2451 %! cast ([1i; 2i; 3], tr));
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2452 %! assert (cat (1, cast ([1i; 2], t1), cast (3i, t2)),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2453 %! cast ([1i; 2; 3i], tr));
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2454 %! assert (cat (1, cast ([1i; 2], t1), cast ([3i; 4], t2)),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2455 %! cast ([1i; 2; 3i; 4], tr));
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2456 %! assert (cat (2, cast (1i, t1), cast (2i, t2)), cast ([1i, 2i], tr));
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2457 %! assert (cat (2, cast (1i, t1), cast ([2i, 3], t2)),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2458 %! cast ([1i, 2i, 3], tr));
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2459 %! assert (cat (2, cast ([1i, 2], t1), cast (3i, t2)),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2460 %! cast ([1i, 2, 3i], tr));
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2461 %! assert (cat (2, cast ([1i, 2], t1), cast ([3i, 4], t2)),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2462 %! cast ([1i, 2, 3i, 4], tr));
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2463 %!
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2464 %! assert ([cast(1i, t1); cast(2i, t2)], cast ([1i; 2i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2465 %! assert ([cast(1i, t1); cast([2i; 3], t2)], cast ([1i; 2i; 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2466 %! assert ([cast([1i; 2], t1); cast(3i, t2)], cast ([1i; 2; 3i], tr));
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2467 %! assert ([cast([1i; 2], t1); cast([3i; 4], t2)],
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2468 %! cast ([1i; 2; 3i; 4], tr));
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2469 %! assert ([cast(1i, t1), cast(2i, t2)], cast ([1i, 2i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2470 %! assert ([cast(1i, t1), cast([2i, 3], t2)], cast ([1i, 2i, 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2471 %! assert ([cast([1i, 2], t1), cast(3i, t2)], cast ([1i, 2, 3i], tr));
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2472 %! assert ([cast([1i, 2], t1), cast([3i, 4], t2)],
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	2473 %! cast ([1i, 2, 3i, 4], tr));
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2474 %! endif
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2475 %! ret = true;
14085 4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2476 %!endfunction
4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2477
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2478 %!assert (__testcat ("double", "double", "double"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2479 %!assert (__testcat ("single", "double", "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2480 %!assert (__testcat ("double", "single", "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2481 %!assert (__testcat ("single", "single", "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2482
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2483 %!assert (__testcat ("double", "int8", "int8", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2484 %!assert (__testcat ("int8", "double", "int8", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2485 %!assert (__testcat ("single", "int8", "int8", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2486 %!assert (__testcat ("int8", "single", "int8", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2487 %!assert (__testcat ("int8", "int8", "int8", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2488 %!assert (__testcat ("double", "int16", "int16", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2489 %!assert (__testcat ("int16", "double", "int16", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2490 %!assert (__testcat ("single", "int16", "int16", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2491 %!assert (__testcat ("int16", "single", "int16", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2492 %!assert (__testcat ("int16", "int16", "int16", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2493 %!assert (__testcat ("double", "int32", "int32", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2494 %!assert (__testcat ("int32", "double", "int32", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2495 %!assert (__testcat ("single", "int32", "int32", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2496 %!assert (__testcat ("int32", "single", "int32", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2497 %!assert (__testcat ("int32", "int32", "int32", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2498 %!assert (__testcat ("double", "int64", "int64", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2499 %!assert (__testcat ("int64", "double", "int64", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2500 %!assert (__testcat ("single", "int64", "int64", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2501 %!assert (__testcat ("int64", "single", "int64", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2502 %!assert (__testcat ("int64", "int64", "int64", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2503
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2504 %!assert (__testcat ("double", "uint8", "uint8", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2505 %!assert (__testcat ("uint8", "double", "uint8", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2506 %!assert (__testcat ("single", "uint8", "uint8", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2507 %!assert (__testcat ("uint8", "single", "uint8", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2508 %!assert (__testcat ("uint8", "uint8", "uint8", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2509 %!assert (__testcat ("double", "uint16", "uint16", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2510 %!assert (__testcat ("uint16", "double", "uint16", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2511 %!assert (__testcat ("single", "uint16", "uint16", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2512 %!assert (__testcat ("uint16", "single", "uint16", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2513 %!assert (__testcat ("uint16", "uint16", "uint16", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2514 %!assert (__testcat ("double", "uint32", "uint32", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2515 %!assert (__testcat ("uint32", "double", "uint32", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2516 %!assert (__testcat ("single", "uint32", "uint32", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2517 %!assert (__testcat ("uint32", "single", "uint32", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2518 %!assert (__testcat ("uint32", "uint32", "uint32", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2519 %!assert (__testcat ("double", "uint64", "uint64", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2520 %!assert (__testcat ("uint64", "double", "uint64", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2521 %!assert (__testcat ("single", "uint64", "uint64", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2522 %!assert (__testcat ("uint64", "single", "uint64", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2523 %!assert (__testcat ("uint64", "uint64", "uint64", false))
14085 4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2524
4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2525 %!assert (cat (3, [], [1,2;3,4]), [1,2;3,4])
4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2526 %!assert (cat (3, [1,2;3,4], []), [1,2;3,4])
4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2527 %!assert (cat (3, [], [1,2;3,4], []), [1,2;3,4])
4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2528 %!assert (cat (3, [], [], []), zeros (0, 0, 3))
4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2529
4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2530 %!assert (cat (3, [], [], 1, 2), cat (3, 1, 2))
4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2531 %!assert (cat (3, [], [], [1,2;3,4]), [1,2;3,4])
4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2532 %!assert (cat (4, [], [], [1,2;3,4]), [1,2;3,4])
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2533
18678 6113e0c6920b maint: Clean up extra spaces before/after parentheses. Rik <rik@octave.org> parents: 18676 diff changeset	2534 %!assert ([zeros(3,2,2); ones(1,2,2)], repmat ([0;0;0;1],[1,2,2]))
6113e0c6920b maint: Clean up extra spaces before/after parentheses. Rik <rik@octave.org> parents: 18676 diff changeset	2535 %!assert ([zeros(3,2,2); ones(1,2,2)], vertcat (zeros (3,2,2), ones (1,2,2)))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2536
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	2537 %!test <*49759>
22895 0ab9eecbb165 Concatenate empty matrices/cells in cat() the same as the parser (bug #49759). Rik <rik@octave.org> parents: 22853 diff changeset	2538 %! A = [];
0ab9eecbb165 Concatenate empty matrices/cells in cat() the same as the parser (bug #49759). Rik <rik@octave.org> parents: 22853 diff changeset	2539 %! B = {1; 2};
0ab9eecbb165 Concatenate empty matrices/cells in cat() the same as the parser (bug #49759). Rik <rik@octave.org> parents: 22853 diff changeset	2540 %! assert (cat (1, A, B), {1; 2});
0ab9eecbb165 Concatenate empty matrices/cells in cat() the same as the parser (bug #49759). Rik <rik@octave.org> parents: 22853 diff changeset	2541 %! assert (cat (2, A, B), {1; 2});
0ab9eecbb165 Concatenate empty matrices/cells in cat() the same as the parser (bug #49759). Rik <rik@octave.org> parents: 22853 diff changeset	2542
14085 4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2543 %!error <dimension mismatch> cat (3, cat (3, [], []), [1,2;3,4])
4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2544 %!error <dimension mismatch> cat (3, zeros (0, 0, 2), [1,2;3,4])
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	2545 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	2546
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2547 static octave_value
6959 47f4f4e88166 [project @ 2007-10-04 20:43:32 by jwe] jwe parents: 6953 diff changeset	2548 do_permute (const octave_value_list& args, bool inv)
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2549 {
20850 b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	2550 if (args.length () != 2 \|\| args(1).length () < args(1).ndims ())
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2551 print_usage ();
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2552
20850 b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	2553 Array<int> vec = args(1).int_vector_value ();
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	2554
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	2555 // FIXME: maybe we should create an idx_vector object here
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	2556 // and pass that to permute?
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	2557 int n = vec.numel ();
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	2558 for (int i = 0; i < n; i++)
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	2559 vec(i)--;
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	2560
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	2561 return octave_value (args(0).permute (vec, inv));
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2562 }
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2563
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2564 DEFUN (permute, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2565 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2566 @deftypefn {} {@var{B} =} permute (@var{A}, @var{perm})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2567 Return the generalized transpose for an N-D array object @var{A}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2568
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2569 The permutation vector @var{perm} must contain the elements
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2570 @w{@code{1:ndims (A)}} (in any order, but each element must appear only
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2571 once). The @var{N}th dimension of @var{A} gets remapped to dimension
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2572 @code{@var{PERM}(@var{N})}. For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2573
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2574 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2575 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2576 @var{x} = zeros ([2, 3, 5, 7]);
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2577 size (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2578 @result{} 2 3 5 7
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2579
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2580 size (permute (@var{x}, [2, 1, 3, 4]))
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2581 @result{} 3 2 5 7
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2582
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2583 size (permute (@var{x}, [1, 3, 4, 2]))
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2584 @result{} 2 5 7 3
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2585
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2586 ## The identity permutation
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2587 size (permute (@var{x}, [1, 2, 3, 4]))
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2588 @result{} 2 3 5 7
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2589 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2590 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2591 @seealso{ipermute}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2592 @end deftypefn */)
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2593 {
6959 47f4f4e88166 [project @ 2007-10-04 20:43:32 by jwe] jwe parents: 6953 diff changeset	2594 return do_permute (args, false);
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2595 }
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2596
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2597 DEFUN (ipermute, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2598 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2599 @deftypefn {} {@var{A} =} ipermute (@var{B}, @var{iperm})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2600 The inverse of the @code{permute} function.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2601
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2602 The expression
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2603
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2604 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2605 ipermute (permute (A, perm), perm)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2606 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2607
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2608 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2609 returns the original array @var{A}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2610 @seealso{permute}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2611 @end deftypefn */)
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2612 {
6959 47f4f4e88166 [project @ 2007-10-04 20:43:32 by jwe] jwe parents: 6953 diff changeset	2613 return do_permute (args, true);
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2614 }
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2615
3195 7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	2616 DEFUN (length, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2617 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2618 @deftypefn {} {@var{n} =} length (@var{A})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2619 Return the length of the object @var{A}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2620
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2621 The length is 0 for empty objects, 1 for scalars, and the number of elements
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2622 for vectors. For matrix or N-dimensional objects, the length is the number
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2623 of elements along the largest dimension
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2624 (equivalent to @w{@code{max (size (@var{A}))}}).
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2625 @seealso{numel, size}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2626 @end deftypefn */)
3195 7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	2627 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2628 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2629 print_usage ();
3195 7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	2630
21127 df7891224709 maint: Use "return ovl (...)" in DEFUN macros. Rik <rik@octave.org> parents: 21121 diff changeset	2631 return ovl (args(0).length ());
3195 7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	2632 }
7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	2633
4554 78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2634 DEFUN (ndims, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2635 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2636 @deftypefn {} {@var{n} =} ndims (@var{A})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2637 Return the number of dimensions of @var{A}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2638
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2639 For any array, the result will always be greater than or equal to 2.
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2640 Trailing singleton dimensions are not counted, i.e., trailing dimensions @var{d}
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2641 greater than 2 for which @code{size (@var{A}, @var{d}) = 1}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2642
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2643 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2644 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2645 ndims (ones (4, 1, 2, 1))
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2646 @result{} 3
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2647 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2648 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2649 @seealso{size}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2650 @end deftypefn */)
4554 78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2651 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2652 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2653 print_usage ();
4554 78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2654
25917 ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	2655 // This function must use size() to determine the desired values to be
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	2656 // compatible with Matlab and to allow user-defined class overloading.
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	2657 Matrix sz = octave_value (args(0)).size ();
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	2658
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	2659 octave_idx_type ndims = sz.numel ();
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	2660
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	2661 // Don't count trailing ones. Trailing zeros are not singleton dimension.
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	2662 while ((ndims > 2) && (sz(ndims - 1) == 1))
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	2663 ndims--;
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	2664
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	2665 return ovl (ndims);
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	2666 }
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	2667
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	2668 /*
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	2669 %!assert (ndims (1:5), 2)
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	2670 %!assert (ndims (ones (4, 1, 2, 1)), 3)
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	2671 %!assert (ndims (ones (4, 1, 2, 0)), 4)
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	2672 */
4554 78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2673
4559 802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2674 DEFUN (numel, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2675 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2676 @deftypefn {} {@var{n} =} numel (@var{A})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2677 @deftypefnx {} {@var{n} =} numel (@var{A}, @var{idx1}, @var{idx2}, @dots{})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2678 Return the number of elements in the object @var{A}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2679
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2680 Optionally, if indices @var{idx1}, @var{idx2}, @dots{} are supplied,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2681 return the number of elements that would result from the indexing
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2682
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2683 @example
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2684 @var{A}(@var{idx1}, @var{idx2}, @dots{})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2685 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2686
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2687 Note that the indices do not have to be scalar numbers. For example,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2688
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2689 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2690 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2691 @var{a} = 1;
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2692 @var{b} = ones (2, 3);
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2693 numel (@var{a}, @var{b})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2694 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2695 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2696
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2697 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2698 will return 6, as this is the number of ways to index with @var{b}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2699 Or the index could be the string @qcode{":"} which represents the colon
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2700 operator. For example,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2701
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2702 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2703 @group
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2704 @var{A} = ones (5, 3);
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2705 numel (@var{A}, 2, ":")
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2706 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2707 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2708
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2709 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2710 will return 3 as the second row has three column entries.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2711
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2712 This method is also called when an object appears as lvalue with cs-list
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2713 indexing, i.e., @code{object@{@dots{}@}} or @code{object(@dots{}).field}.
22429 00986ee43956 doc: Add more @seealso links to numel, size, size_equal. Rik <rik@octave.org> parents: 22407 diff changeset	2714 @seealso{size, length, ndims}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2715 @end deftypefn */)
4559 802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2716 {
20850 b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	2717 int nargin = args.length ();
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	2718
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	2719 if (nargin == 0)
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	2720 print_usage ();
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	2721
4559 802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2722 octave_value retval;
9329 67fc970dad7d improve indexed assignment using indexed numel Jaroslav Hajek <highegg@gmail.com> parents: 9319 diff changeset	2723
9705 5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2724 if (nargin == 1)
5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2725 retval = args(0).numel ();
5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2726 else if (nargin > 1)
4559 802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2727 {
9705 5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2728 // Don't use numel (const octave_value_list&) here as that corresponds to
5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2729 // an overloaded call, not to builtin!
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	2730 retval = dims_to_numel (args(0).dims (), args.slice (1, nargin-1));
4559 802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2731 }
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2732
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2733 return retval;
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2734 }
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2735
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	2736 DEFUN (size, args, nargout,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2737 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2738 @deftypefn {} {@var{sz} =} size (@var{A})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2739 @deftypefnx {} {@var{dim_sz} =} size (@var{A}, @var{dim})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2740 @deftypefnx {} {@var{dim_sz} =} size (@var{A}, @var{d1}, @var{d2}, @dots{})
22699 2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2741 @deftypefnx {} {[@var{rows}, @var{cols}, @dots{}, @var{dim_N_sz}] =} size (@dots{})
2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2742 Return a row vector with the size (number of elements) of each dimension for
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2743 the object @var{A}.
22699 2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2744
2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2745 When given a second argument, @var{dim}, return the size of the corresponding
30230 bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2746 dimension. If @var{dim} is a vector, return each of the corresponding
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2747 dimensions. Multiple dimensions may also be specified as separate arguments.
22699 2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2748
2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2749 With a single output argument, @code{size} returns a row vector. When called
2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2750 with multiple output arguments, @code{size} returns the size of dimension N
2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2751 in the Nth argument. The number of rows, dimension 1, is returned in the
2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2752 first argument, the number of columns, dimension 2, is returned in the
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2753 second argument, etc. If there are more dimensions in @var{A} than there are
22699 2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2754 output arguments, @code{size} returns the total number of elements in the
32989 9cbd0bbe7bd8 doc: Document behavior of size when DIM arg exceeds actual number of dimensions (bug #65261) Rik <rik@octave.org> parents: 32807 diff changeset	2755 remaining dimensions in the final output argument. If the requested dimension
9cbd0bbe7bd8 doc: Document behavior of size when DIM arg exceeds actual number of dimensions (bug #65261) Rik <rik@octave.org> parents: 32807 diff changeset	2756 @var{dim} is greater than the number of dimensions in @var{A}, @code{size}
9cbd0bbe7bd8 doc: Document behavior of size when DIM arg exceeds actual number of dimensions (bug #65261) Rik <rik@octave.org> parents: 32807 diff changeset	2757 returns 1 (not 0).
22699 2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2758
2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2759 Example 1: single row vector output
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2760
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2761 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2762 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2763 size ([1, 2; 3, 4; 5, 6])
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2764 @result{} [ 3, 2 ]
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2765 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2766 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2767
22699 2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2768 Example 2: number of elements in 2nd dimension (columns)
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2769
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2770 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2771 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2772 size ([1, 2; 3, 4; 5, 6], 2)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2773 @result{} 2
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2774 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2775 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2776
22699 2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2777 Example 3: number of output arguments == number of dimensions
2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2778
2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2779 @example
2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2780 @group
2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2781 [nr, nc] = size ([1, 2; 3, 4; 5, 6])
2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2782 @result{} nr = 3
2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2783 @result{} nc = 2
2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2784 @end group
2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2785 @end example
2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2786
25574 0e09d5fd7dab doc: Clarify description of Example 4 for size() (bug #54283). Rik <rik@octave.org> parents: 25471 diff changeset	2787 Example 4: number of output arguments < number of dimensions
22699 2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2788
2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2789 @example
2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2790 @group
22845 e23f7f47d8a3 doc: Small fixes to docstrings (bug #49733). Rik <rik@octave.org> parents: 22827 diff changeset	2791 [nr, remainder] = size (ones (2, 3, 4, 5))
22699 2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2792 @result{} nr = 2
2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2793 @result{} remainder = 60
2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2794 @end group
2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2795 @end example
2100cd2e1be0 doc: Clarify behavior of size (bug #49478). Rik <rik@octave.org> parents: 22495 diff changeset	2796
32989 9cbd0bbe7bd8 doc: Document behavior of size when DIM arg exceeds actual number of dimensions (bug #65261) Rik <rik@octave.org> parents: 32807 diff changeset	2797 Example 5: number of elements in dimension > number of actual dimensions
9cbd0bbe7bd8 doc: Document behavior of size when DIM arg exceeds actual number of dimensions (bug #65261) Rik <rik@octave.org> parents: 32807 diff changeset	2798
9cbd0bbe7bd8 doc: Document behavior of size when DIM arg exceeds actual number of dimensions (bug #65261) Rik <rik@octave.org> parents: 32807 diff changeset	2799 @example
9cbd0bbe7bd8 doc: Document behavior of size when DIM arg exceeds actual number of dimensions (bug #65261) Rik <rik@octave.org> parents: 32807 diff changeset	2800 @group
9cbd0bbe7bd8 doc: Document behavior of size when DIM arg exceeds actual number of dimensions (bug #65261) Rik <rik@octave.org> parents: 32807 diff changeset	2801 sz4 = size (ones (2, 3), 4)
9cbd0bbe7bd8 doc: Document behavior of size when DIM arg exceeds actual number of dimensions (bug #65261) Rik <rik@octave.org> parents: 32807 diff changeset	2802 @result{} sz4 = 1
9cbd0bbe7bd8 doc: Document behavior of size when DIM arg exceeds actual number of dimensions (bug #65261) Rik <rik@octave.org> parents: 32807 diff changeset	2803 @end group
9cbd0bbe7bd8 doc: Document behavior of size when DIM arg exceeds actual number of dimensions (bug #65261) Rik <rik@octave.org> parents: 32807 diff changeset	2804 @end example
9cbd0bbe7bd8 doc: Document behavior of size when DIM arg exceeds actual number of dimensions (bug #65261) Rik <rik@octave.org> parents: 32807 diff changeset	2805
22429 00986ee43956 doc: Add more @seealso links to numel, size, size_equal. Rik <rik@octave.org> parents: 22407 diff changeset	2806 @seealso{numel, ndims, length, rows, columns, size_equal, common_size}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2807 @end deftypefn */)
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2808 {
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2809 int nargin = args.length ();
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2810
30230 bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2811 if (nargin == 0)
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2812 print_usage ();
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2813
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2814 // For compatibility with Matlab, size returns dimensions as doubles.
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2815
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2816 Matrix m;
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2817
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2818 dim_vector dimensions = args(0).dims ();
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2819 int ndims = dimensions.ndims ();
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2820
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4512 diff changeset	2821 if (nargin == 1)
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2822 {
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4512 diff changeset	2823 if (nargout > 1)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2824 {
30230 bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2825 dimensions = dimensions.redim (nargout);
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2826 ndims = dimensions.ndims ();
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2827 }
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2828
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2829 m.resize (1, ndims);
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2830
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2831 for (octave_idx_type i = 0; i < ndims; i++)
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2832 m(i) = dimensions(i);
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2833 }
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2834 else
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2835 {
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2836 Array<octave_idx_type> query_dims;
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2837
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2838 if (nargin > 2)
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2839 {
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2840 query_dims.resize (dim_vector (1, nargin-1));
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2841
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2842 for (octave_idx_type i = 0; i < nargin-1; i++)
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2843 query_dims(i) = args(i+1).idx_type_value (true);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2844 }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4512 diff changeset	2845 else
30230 bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2846 query_dims = args(1).octave_idx_type_vector_value (true);
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2847
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2848 if (nargout > 1 && nargout != query_dims.numel ())
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2849 error ("size: nargout > 1 but does not match number of requested dimensions");
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2850
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2851 octave_idx_type nidx = query_dims.numel ();
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2852
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2853 m.resize (1, nidx);
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2854
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2855 for (octave_idx_type i = 0; i < nidx; i++)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2856 {
30230 bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2857 octave_idx_type nd = query_dims.xelem (i);
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2858
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2859 if (nd < 1)
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2860 error ("size: requested dimension DIM (= %"
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2861 OCTAVE_IDX_TYPE_FORMAT ") out of range", nd);
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2862
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2863 m(i) = nd <= ndims ? dimensions (nd-1) : 1;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2864 }
1031 59f5eb2d5eb3 [project @ 1995-01-15 21:11:11 by jwe] jwe parents: 1009 diff changeset	2865 }
30230 bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2866
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2867 if (nargout > 1)
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2868 {
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2869 octave_value_list retval (nargout);
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2870
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2871 for (octave_idx_type i = 0; i < nargout; i++)
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2872 retval(i) = m(i);
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2873
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2874 return retval;
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2875 }
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2876
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2877 return ovl (m);
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2878 }
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2879
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2880 /*
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2881 ## Plain call
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2882
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2883 %!assert (size ([1, 2; 3, 4; 5, 6]), [3, 2])
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2884
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2885 %!test
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2886 %! [nr, nc] = size ([1, 2; 3, 4; 5, 6]);
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2887 %! assert (nr, 3)
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2888 %! assert (nc, 2)
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2889
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2890 %!test
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2891 %! [nr, remainder] = size (ones (2, 3, 4, 5));
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2892 %! assert (nr, 2)
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2893 %! assert (remainder, 60)
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2894
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2895 ## Call for single existing dimension
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2896
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2897 %!assert (size ([1, 2; 3, 4; 5, 6], 1), 3)
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2898 %!assert (size ([1, 2; 3, 4; 5, 6], 2), 2)
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2899
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2900 ## Call for single non-existing dimension
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2901
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2902 %!assert (size ([1, 2; 3, 4; 5, 6], 3), 1)
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2903 %!assert (size ([1, 2; 3, 4; 5, 6], 4), 1)
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2904
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2905 ## Call for more than existing dimensions
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2906
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2907 %!test
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2908 %! [nr, nc, e1, e2] = size ([1, 2; 3, 4; 5, 6]);
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2909 %! assert (nr, 3)
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2910 %! assert (nc, 2)
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2911 %! assert (e1, 1)
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2912 %! assert (e2, 1)
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2913
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2914 ## Call for two arbitrary dimensions
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2915
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2916 %!test
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2917 %! dim = [3, 2, 1, 1, 1];
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2918 %! for i = 1:5
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2919 %! for j = 1:5
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2920 %! assert (size ([1, 2; 3, 4; 5, 6], i, j), [dim(i), dim(j)])
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2921 %! assert (size ([1, 2; 3, 4; 5, 6], [i, j]), [dim(i), dim(j)])
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2922 %! [a, b] = size ([1, 2; 3, 4; 5, 6], i, j);
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2923 %! assert (a, dim(i));
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2924 %! assert (b, dim(j));
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2925 %! [a, b] = size ([1, 2; 3, 4; 5, 6], [i, j]);
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2926 %! assert (a, dim(i));
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2927 %! assert (b, dim(j));
31564 332a6ccac881 maint: cleanup code in BIST tests to use Octave coding conventions. Rik <rik@octave.org> parents: 31375 diff changeset	2928 %! endfor
332a6ccac881 maint: cleanup code in BIST tests to use Octave coding conventions. Rik <rik@octave.org> parents: 31375 diff changeset	2929 %! endfor
30230 bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2930
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2931 ## Call for three arbitrary dimensions
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2932
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2933 %!test
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2934 %! dim = [3, 2, 1, 1, 1];
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2935 %! for i = 1:5
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2936 %! for j = 1:5
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2937 %! for k = 1:5
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2938 %! assert (size ([1, 2; 3, 4; 5, 6], i, j, k), [dim(i), dim(j), dim(k)])
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2939 %! assert (size ([1, 2; 3, 4; 5, 6], [i, j, k]), [dim(i), dim(j), dim(k)])
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2940 %! [a, b, c] = size ([1, 2; 3, 4; 5, 6], i, j, k);
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2941 %! assert (a, dim(i));
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2942 %! assert (b, dim(j));
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2943 %! assert (c, dim(k));
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2944 %! [a, b, c] = size ([1, 2; 3, 4; 5, 6], [i, j, k]);
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2945 %! assert (a, dim(i));
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2946 %! assert (b, dim(j));
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2947 %! assert (c, dim(k));
31564 332a6ccac881 maint: cleanup code in BIST tests to use Octave coding conventions. Rik <rik@octave.org> parents: 31375 diff changeset	2948 %! endfor
332a6ccac881 maint: cleanup code in BIST tests to use Octave coding conventions. Rik <rik@octave.org> parents: 31375 diff changeset	2949 %! endfor
332a6ccac881 maint: cleanup code in BIST tests to use Octave coding conventions. Rik <rik@octave.org> parents: 31375 diff changeset	2950 %! endfor
30230 bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2951
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2952 %!error <does not match number of requested dimensions>
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2953 %! [a, b, c] = size ([1, 2; 3, 4; 5, 6], 1:4)
bd02f48ac38f allow size function to query arbitrary list of dimensions (bug #61098) John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	2954 */
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2955
6156 a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2956 DEFUN (size_equal, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2957 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2958 @deftypefn {} {@var{TF} =} size_equal (@var{A}, @var{B})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2959 @deftypefnx {} {@var{TF} =} size_equal (@var{A}, @var{B}, @dots{})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2960 Return true if the dimensions of all arguments agree.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2961
22429 00986ee43956 doc: Add more @seealso links to numel, size, size_equal. Rik <rik@octave.org> parents: 22407 diff changeset	2962 Trailing singleton dimensions are ignored. When called with a single argument,
00986ee43956 doc: Add more @seealso links to numel, size, size_equal. Rik <rik@octave.org> parents: 22407 diff changeset	2963 or no argument, @code{size_equal} returns true.
00986ee43956 doc: Add more @seealso links to numel, size, size_equal. Rik <rik@octave.org> parents: 22407 diff changeset	2964 @seealso{size, numel, ndims, common_size}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2965 @end deftypefn */)
6156 a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2966 {
6561 dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2967 int nargin = args.length ();
dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2968
8947 1e4b3149365a allow size_equal called with 1 arg Jaroslav Hajek <highegg@gmail.com> parents: 8934 diff changeset	2969 if (nargin >= 1)
6156 a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2970 {
32598 2f3b54f81947 avoid dim_vector copies in more places where possible (bug #64962) John W. Eaton <jwe@octave.org> parents: 32585 diff changeset	2971 const dim_vector& a_dims = args(0).dims ();
6561 dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2972
dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2973 for (int i = 1; i < nargin; ++i)
dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2974 {
32598 2f3b54f81947 avoid dim_vector copies in more places where possible (bug #64962) John W. Eaton <jwe@octave.org> parents: 32585 diff changeset	2975 const dim_vector& b_dims = args(i).dims ();
6561 dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2976
dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2977 if (a_dims != b_dims)
21078 49852ff04747 maint: Remove unnecessary declarations of retval. Rik <rik@octave.org> parents: 21062 diff changeset	2978 return ovl (false);
6561 dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2979 }
6156 a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2980 }
a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2981
21078 49852ff04747 maint: Remove unnecessary declarations of retval. Rik <rik@octave.org> parents: 21062 diff changeset	2982 return ovl (true);
6156 a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2983 }
a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2984
5602 dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2985 DEFUN (nnz, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2986 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2987 @deftypefn {} {@var{n} =} nnz (@var{A})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	2988 Return the number of nonzero elements in @var{A}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2989 @seealso{nzmax, nonzeros, find}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	2990 @end deftypefn */)
5602 dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2991 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2992 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2993 print_usage ();
5602 dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2994
21127 df7891224709 maint: Use "return ovl (...)" in DEFUN macros. Rik <rik@octave.org> parents: 21121 diff changeset	2995 return ovl (args(0).nnz ());
5602 dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2996 }
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2997
24859 00ecff875f8a Add nnz implementation for Range type (bug #53185). maorshutman <maorus12@gmail.com> parents: 24634 diff changeset	2998 /*
00ecff875f8a Add nnz implementation for Range type (bug #53185). maorshutman <maorus12@gmail.com> parents: 24634 diff changeset	2999 %!assert (nnz (1:5), 5)
00ecff875f8a Add nnz implementation for Range type (bug #53185). maorshutman <maorus12@gmail.com> parents: 24634 diff changeset	3000 %!assert (nnz (-5:-1), 5)
00ecff875f8a Add nnz implementation for Range type (bug #53185). maorshutman <maorus12@gmail.com> parents: 24634 diff changeset	3001 %!assert (nnz (0:5), 5)
00ecff875f8a Add nnz implementation for Range type (bug #53185). maorshutman <maorus12@gmail.com> parents: 24634 diff changeset	3002 %!assert (nnz (-5:0), 5)
00ecff875f8a Add nnz implementation for Range type (bug #53185). maorshutman <maorus12@gmail.com> parents: 24634 diff changeset	3003 %!assert (nnz (-5:5), 10)
00ecff875f8a Add nnz implementation for Range type (bug #53185). maorshutman <maorus12@gmail.com> parents: 24634 diff changeset	3004 %!assert (nnz (-2:1:2), 4)
28915 c40a367a84c0 maint: Use Octave convention of space after function name in libinterp/. Rik <rik@octave.org> parents: 28888 diff changeset	3005 %!assert (nnz (-2+eps (2):1:2), 5)
c40a367a84c0 maint: Use Octave convention of space after function name in libinterp/. Rik <rik@octave.org> parents: 28888 diff changeset	3006 %!assert (nnz (-2-eps (2):1:2), 5)
c40a367a84c0 maint: Use Octave convention of space after function name in libinterp/. Rik <rik@octave.org> parents: 28888 diff changeset	3007 %!assert (nnz (-2:1+eps (1):2), 5)
c40a367a84c0 maint: Use Octave convention of space after function name in libinterp/. Rik <rik@octave.org> parents: 28888 diff changeset	3008 %!assert (nnz (-2:1-eps (1):2), 5)
24859 00ecff875f8a Add nnz implementation for Range type (bug #53185). maorshutman <maorus12@gmail.com> parents: 24634 diff changeset	3009 %!assert (nnz ([1:5] * 0), 0)
00ecff875f8a Add nnz implementation for Range type (bug #53185). maorshutman <maorus12@gmail.com> parents: 24634 diff changeset	3010 %!assert (nnz ([-5:-1] * 0), 0)
00ecff875f8a Add nnz implementation for Range type (bug #53185). maorshutman <maorus12@gmail.com> parents: 24634 diff changeset	3011 %!assert (nnz ([-1:1] * 0), 0)
00ecff875f8a Add nnz implementation for Range type (bug #53185). maorshutman <maorus12@gmail.com> parents: 24634 diff changeset	3012 */
00ecff875f8a Add nnz implementation for Range type (bug #53185). maorshutman <maorus12@gmail.com> parents: 24634 diff changeset	3013
5604 2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	3014 DEFUN (nzmax, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3015 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3016 @deftypefn {} {@var{n} =} nzmax (@var{SM})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3017 Return the amount of storage allocated to the sparse matrix @var{SM}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3018
27081 c0d8ce61c1c9 Always reserve at least 1 element of storage for sparse matrices (bug #56232). Rik <rik@octave.org> parents: 27034 diff changeset	3019 Programming Note: Octave tends to crop unused memory at the first opportunity
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3020 for sparse objects. Thus, in general the value of @code{nzmax} will be the
27081 c0d8ce61c1c9 Always reserve at least 1 element of storage for sparse matrices (bug #56232). Rik <rik@octave.org> parents: 27034 diff changeset	3021 same as @code{nnz}, except for some cases of user-created sparse objects.
c0d8ce61c1c9 Always reserve at least 1 element of storage for sparse matrices (bug #56232). Rik <rik@octave.org> parents: 27034 diff changeset	3022
c0d8ce61c1c9 Always reserve at least 1 element of storage for sparse matrices (bug #56232). Rik <rik@octave.org> parents: 27034 diff changeset	3023 Also, note that Octave always reserves storage for at least one value. Thus,
c0d8ce61c1c9 Always reserve at least 1 element of storage for sparse matrices (bug #56232). Rik <rik@octave.org> parents: 27034 diff changeset	3024 for empty matrices @code{nnz} will report 0, but @code{nzmax} will report 1.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3025 @seealso{nnz, spalloc, sparse}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3026 @end deftypefn */)
5604 2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	3027 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3028 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	3029 print_usage ();
5604 2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	3030
21127 df7891224709 maint: Use "return ovl (...)" in DEFUN macros. Rik <rik@octave.org> parents: 21121 diff changeset	3031 return ovl (args(0).nzmax ());
5604 2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	3032 }
2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	3033
5677 a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	3034 DEFUN (rows, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3035 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	3036 @deftypefn {} {@var{nr} =} rows (@var{A})
32583 c273d7fdab3a doc: Add height and width info to rows and columns docstrings (bug #64995) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32582 diff changeset	3037 @deftypefnx () {@var{nr} =} height (@var{A})
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	3038 Return the number of rows of @var{A}.
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	3039
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	3040 This is equivalent to @code{size (@var{A}, 1)}.
32583 c273d7fdab3a doc: Add height and width info to rows and columns docstrings (bug #64995) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32582 diff changeset	3041
32585 8c4dfe87d2cf Correct inconsistent alias note from c273d7fdab3a (bug #64995) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32583 diff changeset	3042 Programming Note: @code{height} is an alias for @code{rows} and can be
8c4dfe87d2cf Correct inconsistent alias note from c273d7fdab3a (bug #64995) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32583 diff changeset	3043 used interchangeably.
32583 c273d7fdab3a doc: Add height and width info to rows and columns docstrings (bug #64995) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32582 diff changeset	3044
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3045 @seealso{columns, size, length, numel, isscalar, isvector, ismatrix}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3046 @end deftypefn */)
5677 a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	3047 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3048 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	3049 print_usage ();
5677 a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	3050
25917 ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3051 // This function must use size() to determine the desired values to
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3052 // allow user-defined class overloading.
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3053
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3054 return ovl ((octave_value (args(0)).size ())(0));
5677 a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	3055 }
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	3056
32551 cbc71d7652e8 new height and width aliases for rows and columns (bug #64995) John W. Eaton <jwe@octave.org> parents: 32513 diff changeset	3057 DEFALIAS (height, rows);
cbc71d7652e8 new height and width aliases for rows and columns (bug #64995) John W. Eaton <jwe@octave.org> parents: 32513 diff changeset	3058
20810 dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3059 /*
dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3060 %!assert (rows (ones (2,5)), 2)
dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3061 %!assert (rows (ones (5,2)), 5)
20811 5979314bb15a Fix BIST tests for rows. Rik <rik@octave.org> parents: 20810 diff changeset	3062 %!assert (rows (ones (5,4,3,2)), 5)
20810 dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3063 %!assert (rows (ones (3,4,5,2)), 3)
dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3064
dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3065 %!assert (rows (cell (2,5)), 2)
dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3066 %!assert (rows (cell (5,2)), 5)
20811 5979314bb15a Fix BIST tests for rows. Rik <rik@octave.org> parents: 20810 diff changeset	3067 %!assert (rows (cell (5,4,3,2)), 5)
20810 dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3068 %!assert (rows (cell (3,4,5,2)), 3)
dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3069
dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3070 %!test
dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3071 %! x(2,5,3).a = 1;
dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3072 %! assert (rows (x), 2);
dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3073 %! y(5,4,3).b = 2;
dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3074 %! assert (rows (y), 5);
dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3075
dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3076 %!assert (rows ("Hello World"), 1)
dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3077
dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3078 %!assert (rows ([]), 0)
20815 6935b8f038cc Fix BIST tests for rows() Rik <rik@octave.org> parents: 20811 diff changeset	3079 %!assert (rows (zeros (2,0)), 2)
20810 dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3080
dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3081 ## Test input validation
dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3082 %!error rows ()
dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3083 %!error rows (1,2)
dc9039163760 Add BIST tests for rows(). Rik <rik@octave.org> parents: 20809 diff changeset	3084 */
5677 a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	3085
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	3086 DEFUN (columns, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3087 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	3088 @deftypefn {} {@var{nc} =} columns (@var{A})
32583 c273d7fdab3a doc: Add height and width info to rows and columns docstrings (bug #64995) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32582 diff changeset	3089 @deftypefnx {} {@var{nc} =} width (@var{A})
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	3090 Return the number of columns of @var{A}.
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	3091
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	3092 This is equivalent to @code{size (@var{A}, 2)}.
32583 c273d7fdab3a doc: Add height and width info to rows and columns docstrings (bug #64995) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32582 diff changeset	3093
32585 8c4dfe87d2cf Correct inconsistent alias note from c273d7fdab3a (bug #64995) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32583 diff changeset	3094 Programming Note: @code{width} is an alias for @code{columns} and can be
8c4dfe87d2cf Correct inconsistent alias note from c273d7fdab3a (bug #64995) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32583 diff changeset	3095 used interchangeably.
32583 c273d7fdab3a doc: Add height and width info to rows and columns docstrings (bug #64995) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32582 diff changeset	3096
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3097 @seealso{rows, size, length, numel, isscalar, isvector, ismatrix}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3098 @end deftypefn */)
5677 a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	3099 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3100 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	3101 print_usage ();
5677 a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	3102
25917 ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3103 // This function must use size() to determine the desired values to
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3104 // allow user-defined class overloading.
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3105
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3106 return ovl ((octave_value (args(0)).size ())(1));
5677 a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	3107 }
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	3108
32551 cbc71d7652e8 new height and width aliases for rows and columns (bug #64995) John W. Eaton <jwe@octave.org> parents: 32513 diff changeset	3109 DEFALIAS (width, columns);
cbc71d7652e8 new height and width aliases for rows and columns (bug #64995) John W. Eaton <jwe@octave.org> parents: 32513 diff changeset	3110
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	3111 DEFUN (sum, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3112 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	3113 @deftypefn {} {@var{y} =} sum (@var{x})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	3114 @deftypefnx {} {@var{y} =} sum (@var{x}, @var{dim})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	3115 @deftypefnx {} {@var{y} =} sum (@dots{}, "native")
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	3116 @deftypefnx {} {@var{y} =} sum (@dots{}, "double")
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	3117 @deftypefnx {} {@var{y} =} sum (@dots{}, "extra")
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3118 Sum of elements along dimension @var{dim}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3119
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3120 If @var{dim} is omitted, it defaults to the first non-singleton dimension.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3121
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3122 The optional @qcode{"type"} input determines the class of the variable
25286 44c0aca121cc doc: Clarify docstring for sum (bug #53698). Rik <rik@octave.org> parents: 25103 diff changeset	3123 used for calculations. By default, operations on floating point inputs (double
44c0aca121cc doc: Clarify docstring for sum (bug #53698). Rik <rik@octave.org> parents: 25103 diff changeset	3124 or single) are performed in their native data type, while operations on
44c0aca121cc doc: Clarify docstring for sum (bug #53698). Rik <rik@octave.org> parents: 25103 diff changeset	3125 integer, logical, and character data types are performed using doubles. If the
44c0aca121cc doc: Clarify docstring for sum (bug #53698). Rik <rik@octave.org> parents: 25103 diff changeset	3126 argument @qcode{"native"} is given, then the operation is performed in the same
44c0aca121cc doc: Clarify docstring for sum (bug #53698). Rik <rik@octave.org> parents: 25103 diff changeset	3127 type as the original argument.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3128
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3129 For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3130
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3131 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3132 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3133 sum ([true, true])
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3134 @result{} 2
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3135 sum ([true, true], "native")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3136 @result{} true
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3137 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3138 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3139
25286 44c0aca121cc doc: Clarify docstring for sum (bug #53698). Rik <rik@octave.org> parents: 25103 diff changeset	3140 If @qcode{"double"} is given the sum is performed in double precision even for
44c0aca121cc doc: Clarify docstring for sum (bug #53698). Rik <rik@octave.org> parents: 25103 diff changeset	3141 single precision inputs.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3142
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3143 For double precision inputs, the @qcode{"extra"} option will use a more
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3144 accurate algorithm than straightforward summation. For single precision
25286 44c0aca121cc doc: Clarify docstring for sum (bug #53698). Rik <rik@octave.org> parents: 25103 diff changeset	3145 inputs, @qcode{"extra"} is the same as @qcode{"double"}. For all other data
44c0aca121cc doc: Clarify docstring for sum (bug #53698). Rik <rik@octave.org> parents: 25103 diff changeset	3146 type @qcode{"extra"} has no effect.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3147 @seealso{cumsum, sumsq, prod}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3148 @end deftypefn */)
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3149 {
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3150 int nargin = args.length ();
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3151
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3152 bool isnative = false;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3153 bool isdouble = false;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3154 bool isextra = false;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3155
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3156 if (nargin > 1 && args(nargin - 1).is_string ())
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3157 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3158 std::string str = args(nargin - 1).string_value ();
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3159
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19739 diff changeset	3160 if (str == "native")
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19739 diff changeset	3161 isnative = true;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19739 diff changeset	3162 else if (str == "double")
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19739 diff changeset	3163 isdouble = true;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19739 diff changeset	3164 else if (str == "extra")
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19739 diff changeset	3165 isextra = true;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19739 diff changeset	3166 else
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19739 diff changeset	3167 error ("sum: unrecognized type argument '%s'", str.c_str ());
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	3168
21062 d9c1884d1aaa maint: Eliminate space between variable and decrement '--' operator. Rik <rik@octave.org> parents: 21055 diff changeset	3169 nargin--;
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3170 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3171
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3172 if (nargin < 1 \|\| nargin > 2)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3173 print_usage ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3174
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3175 int dim = -1;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3176 if (nargin == 2)
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3177 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3178 dim = args(1).int_value () - 1;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3179 if (dim < 0)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3180 error ("sum: invalid dimension DIM = %d", dim + 1);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3181 }
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3182
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	3183 octave_value retval;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	3184 octave_value arg = args(0);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	3185
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3186 switch (arg.builtin_type ())
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3187 {
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3188 case btyp_double:
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	3189 if (arg.issparse ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3190 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3191 if (isextra)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3192 warning ("sum: 'extra' not yet implemented for sparse matrices");
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3193 retval = arg.sparse_matrix_value ().sum (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3194 }
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3195 else if (isextra)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3196 retval = arg.array_value ().xsum (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3197 else
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3198 retval = arg.array_value ().sum (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3199 break;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3200
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3201 case btyp_complex:
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	3202 if (arg.issparse ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3203 {
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3204 if (isextra)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3205 warning ("sum: 'extra' not yet implemented for sparse matrices");
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3206 retval = arg.sparse_complex_matrix_value ().sum (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3207 }
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3208 else if (isextra)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3209 retval = arg.complex_array_value ().xsum (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3210 else
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3211 retval = arg.complex_array_value ().sum (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3212 break;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3213
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3214 case btyp_float:
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3215 if (isdouble \|\| isextra)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3216 retval = arg.float_array_value ().dsum (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3217 else
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3218 retval = arg.float_array_value ().sum (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3219 break;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3220
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3221 case btyp_float_complex:
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3222 if (isdouble \|\| isextra)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3223 retval = arg.float_complex_array_value ().dsum (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3224 else
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3225 retval = arg.float_complex_array_value ().sum (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3226 break;
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3227
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	3228 #define MAKE_INT_BRANCH(X) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	3229 case btyp_ ## X: \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	3230 if (isnative) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	3231 retval = arg.X ## _array_value ().sum (dim); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	3232 else \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	3233 retval = arg.X ## _array_value ().dsum (dim); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	3234 break;
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3235
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3236 MAKE_INT_BRANCH (int8);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3237 MAKE_INT_BRANCH (int16);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3238 MAKE_INT_BRANCH (int32);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3239 MAKE_INT_BRANCH (int64);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3240 MAKE_INT_BRANCH (uint8);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3241 MAKE_INT_BRANCH (uint16);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3242 MAKE_INT_BRANCH (uint32);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3243 MAKE_INT_BRANCH (uint64);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3244
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3245 #undef MAKE_INT_BRANCH
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19596 diff changeset	3246
22407 34ce5be04942 maint: Style check C++ code in libinterp/. Rik <rik@octave.org> parents: 22327 diff changeset	3247 // GAGME: Accursed Matlab compatibility...
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3248 case btyp_char:
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3249 if (isextra)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3250 retval = arg.array_value (true).xsum (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3251 else
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3252 retval = arg.array_value (true).sum (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3253 break;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3254
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3255 case btyp_bool:
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	3256 if (arg.issparse ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3257 {
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3258 if (isnative)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3259 retval = arg.sparse_bool_matrix_value ().any (dim);
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3260 else
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3261 retval = arg.sparse_bool_matrix_value ().sum (dim);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3262 }
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3263 else if (isnative)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3264 retval = arg.bool_array_value ().any (dim);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3265 else
22773 7f70e420e342 deprecate boolNDArray::sum and boolNDArray::cumsum John W. Eaton <jwe@octave.org> parents: 22763 diff changeset	3266 retval = arg.array_value ().sum (dim);
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3267 break;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3268
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3269 default:
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21078 diff changeset	3270 err_wrong_type_arg ("sum", arg);
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3271 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3272
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3273 return retval;
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3274 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3275
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	3276 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3277 %!assert (sum ([1, 2, 3]), 6)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3278 %!assert (sum ([-1; -2; -3]), -6)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3279 %!assert (sum ([i, 2+i, -3+2i, 4]), 3+4i)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3280 %!assert (sum ([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i]), [2+2i, 4+4i, 6+6i])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3281
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3282 %!assert (sum (single ([1, 2, 3])), single (6))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3283 %!assert (sum (single ([-1; -2; -3])), single (-6))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3284 %!assert (sum (single ([i, 2+i, -3+2i, 4])), single (3+4i))
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	3285 %!assert (sum (single ([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i])),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	3286 %! single ([2+2i, 4+4i, 6+6i]))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3287
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3288 %!assert (sum ([1, 2; 3, 4], 1), [4, 6])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3289 %!assert (sum ([1, 2; 3, 4], 2), [3; 7])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3290 %!assert (sum (zeros (1, 0)), 0)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3291 %!assert (sum (zeros (1, 0), 1), zeros (1, 0))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3292 %!assert (sum (zeros (1, 0), 2), 0)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3293 %!assert (sum (zeros (0, 1)), 0)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3294 %!assert (sum (zeros (0, 1), 1), 0)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3295 %!assert (sum (zeros (0, 1), 2), zeros (0, 1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3296 %!assert (sum (zeros (2, 0)), zeros (1, 0))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3297 %!assert (sum (zeros (2, 0), 1), zeros (1, 0))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3298 %!assert (sum (zeros (2, 0), 2), [0; 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3299 %!assert (sum (zeros (0, 2)), [0, 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3300 %!assert (sum (zeros (0, 2), 1), [0, 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3301 %!assert (sum (zeros (0, 2), 2), zeros (0, 1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3302 %!assert (sum (zeros (2, 2, 0, 3)), zeros (1, 2, 0, 3))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3303 %!assert (sum (zeros (2, 2, 0, 3), 2), zeros (2, 1, 0, 3))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3304 %!assert (sum (zeros (2, 2, 0, 3), 3), zeros (2, 2, 1, 3))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3305 %!assert (sum (zeros (2, 2, 0, 3), 4), zeros (2, 2, 0))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3306 %!assert (sum (zeros (2, 2, 0, 3), 7), zeros (2, 2, 0, 3))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3307
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3308 %!assert (sum (single ([1, 2; 3, 4]), 1), single ([4, 6]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3309 %!assert (sum (single ([1, 2; 3, 4]), 2), single ([3; 7]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3310 %!assert (sum (zeros (1, 0, "single")), single (0))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3311 %!assert (sum (zeros (1, 0, "single"), 1), zeros (1, 0, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3312 %!assert (sum (zeros (1, 0, "single"), 2), single (0))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3313 %!assert (sum (zeros (0, 1, "single")), single (0))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3314 %!assert (sum (zeros (0, 1, "single"), 1), single (0))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3315 %!assert (sum (zeros (0, 1, "single"), 2), zeros (0, 1, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3316 %!assert (sum (zeros (2, 0, "single")), zeros (1, 0, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3317 %!assert (sum (zeros (2, 0, "single"), 1), zeros (1, 0, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3318 %!assert (sum (zeros (2, 0, "single"), 2), single ([0; 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3319 %!assert (sum (zeros (0, 2, "single")), single ([0, 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3320 %!assert (sum (zeros (0, 2, "single"), 1), single ([0, 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3321 %!assert (sum (zeros (0, 2, "single"), 2), zeros (0, 1, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3322 %!assert (sum (zeros (2, 2, 0, 3, "single")), zeros (1, 2, 0, 3, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3323 %!assert (sum (zeros (2, 2, 0, 3, "single"), 2), zeros (2, 1, 0, 3, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3324 %!assert (sum (zeros (2, 2, 0, 3, "single"), 3), zeros (2, 2, 1, 3, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3325 %!assert (sum (zeros (2, 2, 0, 3, "single"), 4), zeros (2, 2, 0, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3326 %!assert (sum (zeros (2, 2, 0, 3, "single"), 7), zeros (2, 2, 0, 3, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3327
18726 5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18725 diff changeset	3328 ## Test "native"
5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18725 diff changeset	3329 %!assert (sum ([true,true]), 2)
5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18725 diff changeset	3330 %!assert (sum ([true,true], "native"), true)
5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18725 diff changeset	3331 %!assert (sum (int8 ([127,10,-20])), 117)
5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18725 diff changeset	3332 %!assert (sum (int8 ([127,10,-20]), "native"), int8 (107))
5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18725 diff changeset	3333
15623 d928ad126b66 maint: add a new test for Fsum corresponding to cset e9d842dcfc91 Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 15621 diff changeset	3334 ;-)
d928ad126b66 maint: add a new test for Fsum corresponding to cset e9d842dcfc91 Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 15621 diff changeset	3335 %!assert (sum ("Octave") + "8", sumsq (primes (17)))
d928ad126b66 maint: add a new test for Fsum corresponding to cset e9d842dcfc91 Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 15621 diff changeset	3336
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3337 %!error sum ()
18726 5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18725 diff changeset	3338 %!error sum (1,2,3)
5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18725 diff changeset	3339 %!error <unrecognized type argument 'foobar'> sum (1, "foobar")
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	3340 */
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	3341
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	3342 DEFUN (sumsq, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3343 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	3344 @deftypefn {} {@var{y} =} sumsq (@var{x})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	3345 @deftypefnx {} {@var{y} =} sumsq (@var{x}, @var{dim})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3346 Sum of squares of elements along dimension @var{dim}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3347
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3348 If @var{dim} is omitted, it defaults to the first non-singleton dimension.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3349
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3350 This function is conceptually equivalent to computing
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3351
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3352 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3353 sum (x .* conj (x), dim)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3354 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3355
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3356 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3357 but it uses less memory and avoids calling @code{conj} if @var{x} is real.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3358 @seealso{sum, prod}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3359 @end deftypefn */)
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3360 {
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	3361 DATA_REDUCTION (sumsq);
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3362 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3363
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	3364 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3365 %!assert (sumsq ([1, 2, 3]), 14)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3366 %!assert (sumsq ([-1; -2; 4i]), 21)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3367 %!assert (sumsq ([1, 2, 3; 2, 3, 4; 4i, 6i, 2]), [21, 49, 29])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3368
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3369 %!assert (sumsq (single ([1, 2, 3])), single (14))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3370 %!assert (sumsq (single ([-1; -2; 4i])), single (21))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3371 %!assert (sumsq (single ([1, 2, 3; 2, 3, 4; 4i, 6i, 2])), single ([21, 49, 29]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3372
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3373 %!assert (sumsq ([1, 2; 3, 4], 1), [10, 20])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3374 %!assert (sumsq ([1, 2; 3, 4], 2), [5; 25])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3375
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3376 %!assert (sumsq (single ([1, 2; 3, 4]), 1), single ([10, 20]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3377 %!assert (sumsq (single ([1, 2; 3, 4]), 2), single ([5; 25]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3378
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3379 %!error sumsq ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3380 */
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	3381
6688 b26a8e0e42cd [project @ 2007-06-04 06:25:21 by jwe] jwe parents: 6671 diff changeset	3382 DEFUN (islogical, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3383 doc: /* -- texinfo --
30559 841a10208c38 doc: Use TF for output variable in documentation for isXXX functions in libinterp/ directory. Rik <rik@octave.org> parents: 30402 diff changeset	3384 @deftypefn {} {@var{tf} =} islogical (@var{x})
841a10208c38 doc: Use TF for output variable in documentation for isXXX functions in libinterp/ directory. Rik <rik@octave.org> parents: 30402 diff changeset	3385 @deftypefnx {} {@var{tf} =} isbool (@var{x})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3386 Return true if @var{x} is a logical object.
32581 ca5d00ab014c Apply consistent notes in docstrings for aliased functions Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32513 diff changeset	3387
ca5d00ab014c Apply consistent notes in docstrings for aliased functions Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32513 diff changeset	3388 Programming Note: @code{isbool} is an alias for @code{islogical} and can be
ca5d00ab014c Apply consistent notes in docstrings for aliased functions Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32513 diff changeset	3389 used interchangeably.
24474 0b65949870e3 isstring.m: Add new function for identifying string arrays. Rik <rik@octave.org> parents: 24441 diff changeset	3390 @seealso{ischar, isfloat, isinteger, isstring, isnumeric, isa}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3391 @end deftypefn */)
3209 fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	3392 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3393 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	3394 print_usage ();
3209 fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	3395
23579 c20a0fa91c0c maint: Deprecate is_bool_type and replace with islogical. Rik <rik@octave.org> parents: 23577 diff changeset	3396 return ovl (args(0).islogical ());
3209 fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	3397 }
fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	3398
6688 b26a8e0e42cd [project @ 2007-06-04 06:25:21 by jwe] jwe parents: 6671 diff changeset	3399 DEFALIAS (isbool, islogical);
3209 fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	3400
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	3401 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3402 %!assert (islogical (true), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3403 %!assert (islogical (false), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3404 %!assert (islogical ([true, false]), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3405 %!assert (islogical (1), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3406 %!assert (islogical (1i), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3407 %!assert (islogical ([1,1]), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3408 %!assert (islogical (single (1)), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3409 %!assert (islogical (single (1i)), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3410 %!assert (islogical (single ([1,1])), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3411 %!assert (islogical (sparse ([true, false])), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3412 %!assert (islogical (sparse ([1, 0])), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3413 */
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	3414
6223 a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	3415 DEFUN (isinteger, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3416 doc: /* -- texinfo --
30559 841a10208c38 doc: Use TF for output variable in documentation for isXXX functions in libinterp/ directory. Rik <rik@octave.org> parents: 30402 diff changeset	3417 @deftypefn {} {@var{tf} =} isinteger (@var{x})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3418 Return true if @var{x} is an integer object (int8, uint8, int16, etc.).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3419
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3420 Note that @w{@code{isinteger (14)}} is false because numeric constants in
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3421 Octave are double precision floating point values.
24474 0b65949870e3 isstring.m: Add new function for identifying string arrays. Rik <rik@octave.org> parents: 24441 diff changeset	3422 @seealso{isfloat, ischar, islogical, isstring, isnumeric, isa}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3423 @end deftypefn */)
6223 a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	3424 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3425 if (args.length () != 1)
6223 a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	3426 print_usage ();
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	3427
23580 2230f9e10fb3 maint: Deprecate is_integer_type and replace with isinteger. Rik <rik@octave.org> parents: 23579 diff changeset	3428 return ovl (args(0).isinteger ());
6223 a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	3429 }
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	3430
22749 e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3431 /*
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3432 %!assert (isinteger (int8 (16)))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3433 %!assert (isinteger (int16 (16)))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3434 %!assert (isinteger (int32 (16)))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3435 %!assert (isinteger (int64 (16)))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3436
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3437 %!assert (isinteger (uint8 (16)))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3438 %!assert (isinteger (uint16 (16)))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3439 %!assert (isinteger (uint32 (16)))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3440 %!assert (isinteger (uint64 (16)))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3441
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3442 %!assert (isinteger (intmax ("int8")))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3443 %!assert (isinteger (intmax ("int16")))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3444 %!assert (isinteger (intmax ("int32")))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3445 %!assert (isinteger (intmax ("int64")))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3446
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3447 %!assert (isinteger (intmax ("uint8")))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3448 %!assert (isinteger (intmax ("uint16")))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3449 %!assert (isinteger (intmax ("uint32")))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3450 %!assert (isinteger (intmax ("uint64")))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3451
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3452 %!assert (isinteger (intmin ("int8")))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3453 %!assert (isinteger (intmin ("int16")))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3454 %!assert (isinteger (intmin ("int32")))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3455 %!assert (isinteger (intmin ("int64")))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3456
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3457 %!assert (isinteger (intmin ("uint8")))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3458 %!assert (isinteger (intmin ("uint16")))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3459 %!assert (isinteger (intmin ("uint32")))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3460 %!assert (isinteger (intmin ("uint64")))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3461
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3462 %!assert (isinteger (uint8 ([1:10])))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3463 %!assert (isinteger (uint8 ([1:10; 1:10])))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3464
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3465 %!assert (! isinteger (16))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3466 %!assert (! isinteger ("parrot"))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3467 %!assert (! isinteger ([1, 2, 3]))
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3468
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3469 %!error isinteger ()
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3470 %!error isinteger ("multiple", "parameters")
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3471 */
e6bf4f8920d3 * data.cc (Fisinteger): Add BIST tests. NVS Abhilash <nvs232@gmail.com> parents: 22699 diff changeset	3472
4028 ef75c970c8f5 [project @ 2002-08-09 07:19:02 by jwe] jwe parents: 4025 diff changeset	3473 DEFUN (iscomplex, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3474 doc: /* -- texinfo --
30559 841a10208c38 doc: Use TF for output variable in documentation for isXXX functions in libinterp/ directory. Rik <rik@octave.org> parents: 30402 diff changeset	3475 @deftypefn {} {@var{tf} =} iscomplex (@var{x})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3476 Return true if @var{x} is a complex-valued numeric object.
24474 0b65949870e3 isstring.m: Add new function for identifying string arrays. Rik <rik@octave.org> parents: 24441 diff changeset	3477 @seealso{isreal, isnumeric, ischar, isfloat, islogical, isstring, isa}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3478 @end deftypefn */)
3186 edaa9a2d3d9c [project @ 1998-10-02 19:12:19 by jwe] jwe parents: 3174 diff changeset	3479 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3480 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	3481 print_usage ();
3186 edaa9a2d3d9c [project @ 1998-10-02 19:12:19 by jwe] jwe parents: 3174 diff changeset	3482
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	3483 return ovl (args(0).iscomplex ());
3186 edaa9a2d3d9c [project @ 1998-10-02 19:12:19 by jwe] jwe parents: 3174 diff changeset	3484 }
edaa9a2d3d9c [project @ 1998-10-02 19:12:19 by jwe] jwe parents: 3174 diff changeset	3485
26198 d57d30caffd6 Add BISTS tests for iscomplex(). Rik <rik@octave.org> parents: 26164 diff changeset	3486 /*
d57d30caffd6 Add BISTS tests for iscomplex(). Rik <rik@octave.org> parents: 26164 diff changeset	3487 %!assert (iscomplex (4), false)
d57d30caffd6 Add BISTS tests for iscomplex(). Rik <rik@octave.org> parents: 26164 diff changeset	3488 %!assert (iscomplex (i), true)
d57d30caffd6 Add BISTS tests for iscomplex(). Rik <rik@octave.org> parents: 26164 diff changeset	3489 %!assert (iscomplex (4+3i), true)
d57d30caffd6 Add BISTS tests for iscomplex(). Rik <rik@octave.org> parents: 26164 diff changeset	3490 %!assert (iscomplex ([1, 2, 3]), false)
d57d30caffd6 Add BISTS tests for iscomplex(). Rik <rik@octave.org> parents: 26164 diff changeset	3491 %!assert (iscomplex ([1, 2i, 3]), true)
d57d30caffd6 Add BISTS tests for iscomplex(). Rik <rik@octave.org> parents: 26164 diff changeset	3492
d57d30caffd6 Add BISTS tests for iscomplex(). Rik <rik@octave.org> parents: 26164 diff changeset	3493 %!assert (iscomplex (0j), false)
d57d30caffd6 Add BISTS tests for iscomplex(). Rik <rik@octave.org> parents: 26164 diff changeset	3494 %!assert (iscomplex (complex (0,0)), true)
d57d30caffd6 Add BISTS tests for iscomplex(). Rik <rik@octave.org> parents: 26164 diff changeset	3495 %!assert (iscomplex ("4"), false)
d57d30caffd6 Add BISTS tests for iscomplex(). Rik <rik@octave.org> parents: 26164 diff changeset	3496 %!assert (iscomplex ({i}), false)
d57d30caffd6 Add BISTS tests for iscomplex(). Rik <rik@octave.org> parents: 26164 diff changeset	3497
d57d30caffd6 Add BISTS tests for iscomplex(). Rik <rik@octave.org> parents: 26164 diff changeset	3498 ## Test input validation
d57d30caffd6 Add BISTS tests for iscomplex(). Rik <rik@octave.org> parents: 26164 diff changeset	3499 %!error iscomplex ()
d57d30caffd6 Add BISTS tests for iscomplex(). Rik <rik@octave.org> parents: 26164 diff changeset	3500 %!error iscomplex (1, 2)
d57d30caffd6 Add BISTS tests for iscomplex(). Rik <rik@octave.org> parents: 26164 diff changeset	3501 */
d57d30caffd6 Add BISTS tests for iscomplex(). Rik <rik@octave.org> parents: 26164 diff changeset	3502
7576 7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	3503 DEFUN (isfloat, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3504 doc: /* -- texinfo --
30559 841a10208c38 doc: Use TF for output variable in documentation for isXXX functions in libinterp/ directory. Rik <rik@octave.org> parents: 30402 diff changeset	3505 @deftypefn {} {@var{tf} =} isfloat (@var{x})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3506 Return true if @var{x} is a floating-point numeric object.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3507
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3508 Objects of class double or single are floating-point objects.
24474 0b65949870e3 isstring.m: Add new function for identifying string arrays. Rik <rik@octave.org> parents: 24441 diff changeset	3509 @seealso{isinteger, ischar, islogical, isnumeric, isstring, isa}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3510 @end deftypefn */)
7576 7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	3511 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3512 if (args.length () != 1)
7576 7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	3513 print_usage ();
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	3514
23585 570170b6eb09 maint: Deprecate is_float_type and replace with isfloat. Rik <rik@octave.org> parents: 23584 diff changeset	3515 return ovl (args(0).isfloat ());
7576 7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	3516 }
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	3517
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3518 // FIXME: perhaps this should be implemented with an
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3519 // octave_value member function?
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3520
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3521 DEFUN (complex, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3522 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	3523 @deftypefn {} {@var{z} =} complex (@var{x})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	3524 @deftypefnx {} {@var{z} =} complex (@var{re}, @var{im})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3525 Return a complex value from real arguments.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3526
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3527 With 1 real argument @var{x}, return the complex result
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3528 @w{@code{@var{x} + 0i}}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3529
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3530 With 2 real arguments, return the complex result
24440 f8bbaacefc33 doc: Fix various inconsistencies in manual (bug #52712). Rik <rik@octave.org> parents: 23219 diff changeset	3531 @w{@code{@var{re} + @var{im}i}}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3532 @code{complex} can often be more convenient than expressions such as
24440 f8bbaacefc33 doc: Fix various inconsistencies in manual (bug #52712). Rik <rik@octave.org> parents: 23219 diff changeset	3533 @w{@code{a + b*i}}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3534 For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3535
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3536 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3537 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3538 complex ([1, 2], [3, 4])
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3539 @result{} [ 1 + 3i 2 + 4i ]
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3540 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3541 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3542 @seealso{real, imag, iscomplex, abs, arg}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3543 @end deftypefn */)
30673 1182fcd6cdaf Coding changes for performance in complex() (bug #61912) Rik <rik@octave.org> parents: 30594 diff changeset	3544 // Programming Note: Throughout this function the coding pattern
1182fcd6cdaf Coding changes for performance in complex() (bug #61912) Rik <rik@octave.org> parents: 30594 diff changeset	3545 // octave_value (new XXX)) is used. This is done specifically because the
1182fcd6cdaf Coding changes for performance in complex() (bug #61912) Rik <rik@octave.org> parents: 30594 diff changeset	3546 // default octave_value constructor would otherwise perform automatic narrowing
1182fcd6cdaf Coding changes for performance in complex() (bug #61912) Rik <rik@octave.org> parents: 30594 diff changeset	3547 // (i.e., complex values with 0 for the imaginary part would be converted
1182fcd6cdaf Coding changes for performance in complex() (bug #61912) Rik <rik@octave.org> parents: 30594 diff changeset	3548 // to real values). The complex() function must return a complex value
1182fcd6cdaf Coding changes for performance in complex() (bug #61912) Rik <rik@octave.org> parents: 30594 diff changeset	3549 // even when the imaginary part is 0.
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3550 {
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3551 int nargin = args.length ();
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3552
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3553 if (nargin < 1 \|\| nargin > 2)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3554 print_usage ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3555
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3556 octave_value retval;
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3557
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3558 if (nargin == 1)
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3559 {
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3560 octave_value arg = args(0);
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3561
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	3562 if (arg.iscomplex ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3563 retval = arg;
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3564 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3565 {
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	3566 if (arg.issparse ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3567 {
20704 571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	3568 SparseComplexMatrix val = arg.xsparse_complex_matrix_value ("complex: invalid conversion");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3569
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3570 retval = octave_value (new octave_sparse_complex_matrix (val));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3571 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3572 else if (arg.is_single_type ())
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3573 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3574 if (arg.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3575 {
20704 571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	3576 FloatComplex val = arg.xfloat_complex_value ("complex: invalid conversion");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3577
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3578 retval = octave_value (new octave_float_complex (val));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3579 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3580 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3581 {
20704 571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	3582 FloatComplexNDArray val = arg.xfloat_complex_array_value ("complex: invalid conversion");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3583
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3584 retval = octave_value (new octave_float_complex_matrix (val));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3585 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3586 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3587 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3588 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3589 if (arg.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3590 {
20704 571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	3591 Complex val = arg.xcomplex_value ("complex: invalid conversion");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3592
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3593 retval = octave_value (new octave_complex (val));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3594 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3595 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3596 {
20704 571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	3597 ComplexNDArray val = arg.xcomplex_array_value ("complex: invalid conversion");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3598
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3599 retval = octave_value (new octave_complex_matrix (val));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3600 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3601 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3602 }
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3603 }
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3604 else
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3605 {
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3606 octave_value re = args(0);
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3607 octave_value im = args(1);
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3608
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	3609 if (re.issparse () && im.issparse ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3610 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3611 const SparseMatrix re_val = re.sparse_matrix_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3612 const SparseMatrix im_val = im.sparse_matrix_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3613
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3614 if (re.numel () == 1)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3615 {
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3616 SparseComplexMatrix result;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3617 if (re_val.nnz () == 0)
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3618 result = Complex (0, 1) * SparseComplexMatrix (im_val);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3619 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3620 {
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3621 octave_idx_type nr = im_val.rows ();
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3622 octave_idx_type nc = im_val.cols ();
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3623 result = SparseComplexMatrix (nr, nc, re_val(0));
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3624
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3625 for (octave_idx_type j = 0; j < nc; j++)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3626 {
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3627 octave_idx_type off = j * nr;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3628 for (octave_idx_type i = im_val.cidx (j);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3629 i < im_val.cidx (j + 1); i++)
27277 db687716fed6 style fixes: generally aim to break long lines before operators, not after John W. Eaton <jwe@octave.org> parents: 27081 diff changeset	3630 result.data (im_val.ridx (i) + off)
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	3631 += Complex (0, im_val.data (i));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3632 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3633 }
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3634 retval = octave_value (new octave_sparse_complex_matrix (result));
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3635 }
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3636 else if (im.numel () == 1)
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3637 {
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3638 SparseComplexMatrix result;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3639 if (im_val.nnz () == 0)
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3640 result = SparseComplexMatrix (re_val);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3641 else
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3642 {
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3643 octave_idx_type nr = re_val.rows ();
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3644 octave_idx_type nc = re_val.cols ();
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3645 result = SparseComplexMatrix (nr, nc,
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3646 Complex (0, im_val(0)));
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3647
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3648 for (octave_idx_type j = 0; j < nc; j++)
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3649 {
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3650 octave_idx_type off = j * nr;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3651 for (octave_idx_type i = re_val.cidx (j);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3652 i < re_val.cidx (j + 1); i++)
27277 db687716fed6 style fixes: generally aim to break long lines before operators, not after John W. Eaton <jwe@octave.org> parents: 27081 diff changeset	3653 result.data (re_val.ridx (i) + off)
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	3654 += re_val.data (i);
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3655 }
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3656 }
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3657 retval = octave_value (new octave_sparse_complex_matrix (result));
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3658 }
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3659 else
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3660 {
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	3661 if (re_val.dims () != im_val.dims ())
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3662 error ("complex: dimension mismatch");
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	3663
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	3664 SparseComplexMatrix result;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	3665 result = SparseComplexMatrix (re_val)
22407 34ce5be04942 maint: Style check C++ code in libinterp/. Rik <rik@octave.org> parents: 22327 diff changeset	3666 + Complex (0, 1) * SparseComplexMatrix (im_val);
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	3667 retval = octave_value (new octave_sparse_complex_matrix (result));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3668 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3669 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	3670 else if (re.is_single_type () \|\| im.is_single_type ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3671 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3672 if (re.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3673 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3674 float re_val = re.float_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3675
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3676 if (im.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3677 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3678 float im_val = im.double_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3679
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3680 retval = octave_value (new octave_float_complex
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3681 (FloatComplex (re_val, im_val)));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3682 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3683 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3684 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3685 const FloatNDArray im_val = im.float_array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3686
30673 1182fcd6cdaf Coding changes for performance in complex() (bug #61912) Rik <rik@octave.org> parents: 30594 diff changeset	3687 FloatComplexNDArray result (im_val.dims ());
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3688
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3689 for (octave_idx_type i = 0; i < im_val.numel (); i++)
30673 1182fcd6cdaf Coding changes for performance in complex() (bug #61912) Rik <rik@octave.org> parents: 30594 diff changeset	3690 result.xelem (i) = FloatComplex (re_val, im_val.xelem (i));
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3691
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3692 retval = octave_value (new octave_float_complex_matrix
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3693 (result));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3694 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3695 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3696 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3697 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3698 const FloatNDArray re_val = re.float_array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3699
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3700 if (im.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3701 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3702 float im_val = im.float_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3703
30673 1182fcd6cdaf Coding changes for performance in complex() (bug #61912) Rik <rik@octave.org> parents: 30594 diff changeset	3704 FloatComplexNDArray result (re_val.dims ());
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3705
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3706 for (octave_idx_type i = 0; i < re_val.numel (); i++)
30673 1182fcd6cdaf Coding changes for performance in complex() (bug #61912) Rik <rik@octave.org> parents: 30594 diff changeset	3707 result.xelem (i) = FloatComplex (re_val.xelem (i), im_val);
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3708
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3709 retval = octave_value (new octave_float_complex_matrix
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3710 (result));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3711 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3712 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3713 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3714 const FloatNDArray im_val = im.float_array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3715
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	3716 if (re_val.dims () != im_val.dims ())
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3717 error ("complex: dimension mismatch");
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20918 diff changeset	3718
30673 1182fcd6cdaf Coding changes for performance in complex() (bug #61912) Rik <rik@octave.org> parents: 30594 diff changeset	3719 FloatComplexNDArray result (re_val.dims ());
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	3720
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	3721 for (octave_idx_type i = 0; i < re_val.numel (); i++)
30673 1182fcd6cdaf Coding changes for performance in complex() (bug #61912) Rik <rik@octave.org> parents: 30594 diff changeset	3722 result.xelem (i) = FloatComplex (re_val.xelem (i),
1182fcd6cdaf Coding changes for performance in complex() (bug #61912) Rik <rik@octave.org> parents: 30594 diff changeset	3723 im_val.xelem (i));
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	3724
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	3725 retval = octave_value (new octave_float_complex_matrix
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	3726 (result));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3727 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3728 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3729 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	3730 else if (re.numel () == 1)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3731 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3732 double re_val = re.double_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3733
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3734 if (im.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3735 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3736 double im_val = im.double_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3737
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3738 retval = octave_value (new octave_complex
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3739 (Complex (re_val, im_val)));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3740 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3741 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3742 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3743 const NDArray im_val = im.array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3744
30673 1182fcd6cdaf Coding changes for performance in complex() (bug #61912) Rik <rik@octave.org> parents: 30594 diff changeset	3745 ComplexNDArray result (im_val.dims ());
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3746
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3747 for (octave_idx_type i = 0; i < im_val.numel (); i++)
30673 1182fcd6cdaf Coding changes for performance in complex() (bug #61912) Rik <rik@octave.org> parents: 30594 diff changeset	3748 result.xelem (i) = Complex (re_val, im_val.xelem (i));
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3749
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3750 retval = octave_value (new octave_complex_matrix (result));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3751 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3752 }
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3753 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3754 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3755 const NDArray re_val = re.array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3756
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3757 if (im.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3758 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3759 double im_val = im.double_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3760
30673 1182fcd6cdaf Coding changes for performance in complex() (bug #61912) Rik <rik@octave.org> parents: 30594 diff changeset	3761 ComplexNDArray result (re_val.dims ());
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3762
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3763 for (octave_idx_type i = 0; i < re_val.numel (); i++)
30673 1182fcd6cdaf Coding changes for performance in complex() (bug #61912) Rik <rik@octave.org> parents: 30594 diff changeset	3764 result.xelem (i) = Complex (re_val.xelem (i), im_val);
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3765
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3766 retval = octave_value (new octave_complex_matrix (result));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3767 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3768 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3769 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3770 const NDArray im_val = im.array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3771
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	3772 if (re_val.dims () != im_val.dims ())
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	3773 error ("complex: dimension mismatch");
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	3774
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	3775 ComplexNDArray result (re_val.dims (), Complex ());
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	3776
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	3777 for (octave_idx_type i = 0; i < re_val.numel (); i++)
30673 1182fcd6cdaf Coding changes for performance in complex() (bug #61912) Rik <rik@octave.org> parents: 30594 diff changeset	3778 result.xelem (i) = Complex (re_val.xelem (i),
1182fcd6cdaf Coding changes for performance in complex() (bug #61912) Rik <rik@octave.org> parents: 30594 diff changeset	3779 im_val.xelem (i));
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	3780
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	3781 retval = octave_value (new octave_complex_matrix (result));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3782 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3783 }
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3784 }
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3785
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3786 return retval;
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3787 }
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3788
22590 354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3789 /*
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3790 %!error <undefined> 1+Infj
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3791 %!error <undefined> 1+Infi
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3792
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3793 %!test <31974>
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3794 %! assert (Inf + Inf*i, complex (Inf, Inf))
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3795 %!
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3796 %! assert (1 + Inf*i, complex (1, Inf))
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3797 %! assert (1 + Inf*j, complex (1, Inf))
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3798 %!
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3799 %! ## whitespace should not affect parsing
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3800 %! assert (1+Inf*i, complex (1, Inf))
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3801 %! assert (1+Inf*j, complex (1, Inf))
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3802 %!
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3803 %! assert (NaN*j, complex (0, NaN))
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3804 %!
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3805 %! assert (Inf * 4j, complex (0, Inf))
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3806
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3807 %!test <31974>
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3808 %! x = Inf;
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3809 %! assert (x * j, complex (0, Inf))
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3810 %! j = complex (0, 1);
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3811 %! assert (Inf * j, complex (0, Inf))
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3812
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3813 %!test <31974>
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3814 %! exp = complex (zeros (2, 2), Inf (2, 2));
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3815 %! assert (Inf (2, 2) * j, exp)
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3816 %! assert (Inf (2, 2) .* j, exp)
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3817 %! assert (Inf * (ones (2, 2) * j), exp)
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3818 %! assert (Inf (2, 2) .* (ones (2, 2) * j), exp)
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3819
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3820 %!test <31974>
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3821 %! assert ([Inf; 0] * [i, 0], complex ([NaN NaN; 0 0], [Inf NaN; 0 0]))
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3822 %! assert ([Inf, 0] * [i; 0], complex (NaN, Inf))
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3823 %! assert ([Inf, 0] .* [i, 0], complex ([0 0], [Inf 0]))
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3824
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3825 %!test <31974>
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3826 %! m = @(x, y) x * y;
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3827 %! d = @(x, y) x / y;
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3828 %! assert (m (Inf, i), complex (0, +Inf))
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3829 %! assert (d (Inf, i), complex (0, -Inf))
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3830 */
354b7a6e642c Add failing tests for creating numbers with Inf complex parts (bug #31974) Carnë Draug <carandraug@octave.org> parents: 22495 diff changeset	3831
3258 4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	3832 DEFUN (isreal, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3833 doc: /* -- texinfo --
30559 841a10208c38 doc: Use TF for output variable in documentation for isXXX functions in libinterp/ directory. Rik <rik@octave.org> parents: 30402 diff changeset	3834 @deftypefn {} {@var{tf} =} isreal (@var{x})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3835 Return true if @var{x} is a non-complex matrix or scalar.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3836
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3837 For compatibility with @sc{matlab}, this includes logical and character
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3838 matrices.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3839 @seealso{iscomplex, isnumeric, isa}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3840 @end deftypefn */)
3258 4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	3841 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3842 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	3843 print_usage ();
3258 4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	3844
23582 0cc2011d800e maint: Deprecate is_real_type and replace with isreal. Rik <rik@octave.org> parents: 23581 diff changeset	3845 return ovl (args(0).isreal ());
3258 4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	3846 }
4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	3847
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3848 DEFUN (isempty, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3849 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	3850 @deftypefn {} {@var{tf} =} isempty (@var{A})
33018 f034172cb600 doc: Generalize isempty/square/row/vector targets as objects (bug #48088) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32989 diff changeset	3851 Return true if @var{A} is an empty object (any one of its dimensions is
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3852 zero).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3853 @seealso{isnull, isa}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3854 @end deftypefn */)
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3855 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3856 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	3857 print_usage ();
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3858
23577 80c42f4cca13 maint: Deprecate is_empty and replace with isempty. Rik <rik@octave.org> parents: 23576 diff changeset	3859 return ovl (args(0).isempty ());
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3860 }
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3861
16779 8fce0ed4894a Specialize is_empty and numel methods for sparse matrices (debian bug #706376) David Bateman <dbateman@free.fr> parents: 16077 diff changeset	3862 /*
22737 7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22708 diff changeset	3863 ## Debian bug #706376
28915 c40a367a84c0 maint: Use Octave convention of space after function name in libinterp/. Rik <rik@octave.org> parents: 28888 diff changeset	3864 %!assert (isempty (speye (2^16)), false)
16779 8fce0ed4894a Specialize is_empty and numel methods for sparse matrices (debian bug #706376) David Bateman <dbateman@free.fr> parents: 16077 diff changeset	3865 */
8fce0ed4894a Specialize is_empty and numel methods for sparse matrices (debian bug #706376) David Bateman <dbateman@free.fr> parents: 16077 diff changeset	3866
3206 d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	3867 DEFUN (isnumeric, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3868 doc: /* -- texinfo --
30559 841a10208c38 doc: Use TF for output variable in documentation for isXXX functions in libinterp/ directory. Rik <rik@octave.org> parents: 30402 diff changeset	3869 @deftypefn {} {@var{tf} =} isnumeric (@var{x})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3870 Return true if @var{x} is a numeric object, i.e., an integer, real, or
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3871 complex array.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3872
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3873 Logical and character arrays are not considered to be numeric.
30329 81d26e8481a6 maint: Shorten @seealso lines to less than 80 characters (bug #57599) Rik <rik@octave.org> parents: 30230 diff changeset	3874 @seealso{isinteger, isfloat, isreal, iscomplex, ischar, islogical, isstring,
81d26e8481a6 maint: Shorten @seealso lines to less than 80 characters (bug #57599) Rik <rik@octave.org> parents: 30230 diff changeset	3875 iscell, isstruct, isa}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3876 @end deftypefn */)
3206 d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	3877 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3878 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	3879 print_usage ();
3206 d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	3880
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23585 diff changeset	3881 return ovl (args(0).isnumeric ());
3206 d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	3882 }
d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	3883
11435 20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	3884 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3885 %!assert (isnumeric (1), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3886 %!assert (isnumeric (1i), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3887 %!assert (isnumeric ([1,1]), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3888 %!assert (isnumeric (single (1)), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3889 %!assert (isnumeric (single (1i)), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3890 %!assert (isnumeric (single ([1,1])), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3891 %!assert (isnumeric (int8 (1)), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3892 %!assert (isnumeric (uint8 ([1,1])), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3893 %!assert (isnumeric ("Hello World"), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3894 %!assert (isnumeric (true), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3895 %!assert (isnumeric (false), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3896 %!assert (isnumeric ([true, false]), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3897 %!assert (isnumeric (sparse ([true, false])), false)
11435 20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	3898 */
20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	3899
18813 bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3900 DEFUN (isscalar, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3901 doc: /* -- texinfo --
30559 841a10208c38 doc: Use TF for output variable in documentation for isXXX functions in libinterp/ directory. Rik <rik@octave.org> parents: 30402 diff changeset	3902 @deftypefn {} {@var{tf} =} isscalar (@var{x})
28043 711cf9b1be49 doc: Reword isscalar, isvector, isrow, iscolumn, ismatrix, issquare docstrings. Rik <rik@octave.org> parents: 28012 diff changeset	3903 Return true if @var{x} is a scalar.
711cf9b1be49 doc: Reword isscalar, isvector, isrow, iscolumn, ismatrix, issquare docstrings. Rik <rik@octave.org> parents: 28012 diff changeset	3904
33031 388c87433483 doc: Add missing hyphen to isscalar docstring (bug #48088) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 33029 diff changeset	3905 A scalar is a single-element object of any type for which @code{size (@var{x})}
28043 711cf9b1be49 doc: Reword isscalar, isvector, isrow, iscolumn, ismatrix, issquare docstrings. Rik <rik@octave.org> parents: 28012 diff changeset	3906 returns @w{@code{[1, 1]}}.
711cf9b1be49 doc: Reword isscalar, isvector, isrow, iscolumn, ismatrix, issquare docstrings. Rik <rik@octave.org> parents: 28012 diff changeset	3907 @seealso{isvector, ismatrix, size}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3908 @end deftypefn */)
18813 bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3909 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3910 if (args.length () != 1)
18813 bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3911 print_usage ();
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3912
25917 ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3913 // This function must use size() to determine the desired values to be
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3914 // compatible with Matlab and to allow user-defined class overloading.
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3915 Matrix sz = octave_value (args(0)).size ();
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3916
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3917 return ovl (sz.numel () == 2 && sz(0) == 1 && sz(1) == 1);
18813 bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3918 }
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3919
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3920 /*
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3921 %!assert (isscalar (1))
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3922 %!assert (isscalar ([1, 2]), false)
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3923 %!assert (isscalar ([]), false)
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3924 %!assert (isscalar ([1, 2; 3, 4]), false)
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3925
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3926 %!assert (isscalar ("t"))
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3927 %!assert (isscalar ("test"), false)
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3928 %!assert (isscalar (["test"; "ing"]), false)
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3929
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3930 %!test
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3931 %! s.a = 1;
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3932 %! assert (isscalar (s));
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3933
22737 7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22708 diff changeset	3934 ## Test input validation
18813 bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3935 %!error isscalar ()
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3936 %!error isscalar (1, 2)
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3937 */
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18812 diff changeset	3938
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3939 DEFUN (isvector, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3940 doc: /* -- texinfo --
30559 841a10208c38 doc: Use TF for output variable in documentation for isXXX functions in libinterp/ directory. Rik <rik@octave.org> parents: 30402 diff changeset	3941 @deftypefn {} {@var{tf} =} isvector (@var{x})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3942 Return true if @var{x} is a vector.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3943
33029 0b8f3470d1fb doc: Clarify object types for isX functions (bug #48088) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 33018 diff changeset	3944 A vector is a 2-D array of any type where one of the dimensions is equal to 1
0b8f3470d1fb doc: Clarify object types for isX functions (bug #48088) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 33018 diff changeset	3945 (either @nospell{1xN} or @nospell{Nx1}). As a consequence of this definition,
0b8f3470d1fb doc: Clarify object types for isX functions (bug #48088) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 33018 diff changeset	3946 a 1x1 object (a scalar) is also a vector.
28043 711cf9b1be49 doc: Reword isscalar, isvector, isrow, iscolumn, ismatrix, issquare docstrings. Rik <rik@octave.org> parents: 28012 diff changeset	3947 @seealso{isscalar, ismatrix, iscolumn, isrow, size}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3948 @end deftypefn */)
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3949 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3950 if (args.length () != 1)
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3951 print_usage ();
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3952
25917 ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3953 // This function must use size() to determine the desired values to be
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3954 // compatible with Matlab and to allow user-defined class overloading.
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3955 Matrix sz = octave_value (args(0)).size ();
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3956
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3957 return ovl (sz.numel () == 2 && (sz(0) == 1 \|\| sz(1) == 1));
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3958 }
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3959
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3960 /*
19700 00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	3961 %!assert (isvector (1), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	3962 %!assert (isvector ([1; 2; 3]), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	3963 %!assert (isvector ([1, 2, 3]), true)
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3964 %!assert (isvector ([]), false)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3965 %!assert (isvector ([1, 2; 3, 4]), false)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3966
19700 00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	3967 %!assert (isvector ("t"), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	3968 %!assert (isvector ("test"), true)
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3969 %!assert (isvector (["test"; "ing"]), false)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3970
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3971 %!test
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3972 %! s.a = 1;
19700 00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	3973 %! assert (isvector (s), true);
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3974
22737 7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22708 diff changeset	3975 ## Test input validation
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3976 %!error isvector ()
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3977 %!error isvector ([1, 2], 2)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3978 */
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3979
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3980 DEFUN (isrow, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3981 doc: /* -- texinfo --
30559 841a10208c38 doc: Use TF for output variable in documentation for isXXX functions in libinterp/ directory. Rik <rik@octave.org> parents: 30402 diff changeset	3982 @deftypefn {} {@var{tf} =} isrow (@var{x})
28043 711cf9b1be49 doc: Reword isscalar, isvector, isrow, iscolumn, ismatrix, issquare docstrings. Rik <rik@octave.org> parents: 28012 diff changeset	3983 Return true if @var{x} is a row vector.
711cf9b1be49 doc: Reword isscalar, isvector, isrow, iscolumn, ismatrix, issquare docstrings. Rik <rik@octave.org> parents: 28012 diff changeset	3984
33029 0b8f3470d1fb doc: Clarify object types for isX functions (bug #48088) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 33018 diff changeset	3985 A row vector is a 2-D array of any type for which @code{size (@var{x})} returns
28043 711cf9b1be49 doc: Reword isscalar, isvector, isrow, iscolumn, ismatrix, issquare docstrings. Rik <rik@octave.org> parents: 28012 diff changeset	3986 @w{@code{[1, N]}} with non-negative N.
711cf9b1be49 doc: Reword isscalar, isvector, isrow, iscolumn, ismatrix, issquare docstrings. Rik <rik@octave.org> parents: 28012 diff changeset	3987 @seealso{iscolumn, isscalar, isvector, ismatrix, size}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	3988 @end deftypefn */)
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3989 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3990 if (args.length () != 1)
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3991 print_usage ();
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3992
25917 ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3993 // This function must use size() to determine the desired values to be
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3994 // compatible with Matlab and to allow user-defined class overloading.
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3995 Matrix sz = octave_value (args(0)).size ();
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3996
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	3997 return ovl (sz.numel () == 2 && sz(0) == 1);
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3998 }
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	3999
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4000 /*
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4001 %!assert (isrow ([1, 2, 3]))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4002 %!assert (isrow ([1; 2; 3]), false)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4003 %!assert (isrow (1))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4004 %!assert (isrow ([]), false)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4005 %!assert (isrow ([1, 2; 3, 4]), false)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4006
19700 00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4007 %!assert (isrow (ones (1, 0)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4008 %!assert (isrow (ones (1, 1)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4009 %!assert (isrow (ones (1, 2)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4010 %!assert (isrow (ones (1, 1, 1)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4011 %!assert (isrow (ones (1, 1, 1, 1)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4012
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4013 %!assert (isrow (ones (0, 0)), false)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4014 %!assert (isrow (ones (1, 1, 0)), false)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4015
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4016 %!assert (isrow ("t"), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4017 %!assert (isrow ("test"), true)
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4018 %!assert (isrow (["test"; "ing"]), false)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4019
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4020 %!test
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4021 %! s.a = 1;
19700 00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4022 %! assert (isrow (s), true);
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4023
22737 7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22708 diff changeset	4024 ## Test input validation
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4025 %!error isrow ()
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4026 %!error isrow ([1, 2], 2)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4027 */
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4028
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4029 DEFUN (iscolumn, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4030 doc: /* -- texinfo --
30559 841a10208c38 doc: Use TF for output variable in documentation for isXXX functions in libinterp/ directory. Rik <rik@octave.org> parents: 30402 diff changeset	4031 @deftypefn {} {@var{tf} =} iscolumn (@var{x})
28043 711cf9b1be49 doc: Reword isscalar, isvector, isrow, iscolumn, ismatrix, issquare docstrings. Rik <rik@octave.org> parents: 28012 diff changeset	4032 Return true if @var{x} is a column vector.
711cf9b1be49 doc: Reword isscalar, isvector, isrow, iscolumn, ismatrix, issquare docstrings. Rik <rik@octave.org> parents: 28012 diff changeset	4033
33029 0b8f3470d1fb doc: Clarify object types for isX functions (bug #48088) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 33018 diff changeset	4034 A column vector is a 2-D array of any type for which @code{size (@var{x})}
0b8f3470d1fb doc: Clarify object types for isX functions (bug #48088) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 33018 diff changeset	4035 returns @w{@code{[N, 1]}} with non-negative N.
28043 711cf9b1be49 doc: Reword isscalar, isvector, isrow, iscolumn, ismatrix, issquare docstrings. Rik <rik@octave.org> parents: 28012 diff changeset	4036 @seealso{isrow, isscalar, isvector, ismatrix, size}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4037 @end deftypefn */)
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4038 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	4039 if (args.length () != 1)
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4040 print_usage ();
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4041
25917 ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	4042 // This function must use size() to determine the desired values to be
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	4043 // compatible with Matlab and to allow user-defined class overloading.
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	4044 Matrix sz = octave_value (args(0)).size ();
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	4045
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	4046 return ovl (sz.numel () == 2 && sz(1) == 1);
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4047 }
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4048
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4049 /*
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4050 %!assert (iscolumn ([1, 2, 3]), false)
19700 00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4051 %!assert (iscolumn ([1; 2; 3]), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4052 %!assert (iscolumn (1), true)
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4053 %!assert (iscolumn ([]), false)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4054 %!assert (iscolumn ([1, 2; 3, 4]), false)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4055
19700 00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4056 %!assert (iscolumn ("t"), true)
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4057 %!assert (iscolumn ("test"), false)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4058 %!assert (iscolumn (["test"; "ing"]), false)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4059
19700 00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4060 %!assert (iscolumn (ones (0, 1)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4061 %!assert (iscolumn (ones (1, 1)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4062 %!assert (iscolumn (ones (2, 1)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4063 %!assert (iscolumn (ones (1, 1, 1)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4064 %!assert (iscolumn (ones (1, 1, 1, 1)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4065
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4066 %!assert (iscolumn (ones (0, 0)), false)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4067 %!assert (iscolumn (ones (0, 1, 0)), false)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4068
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4069 %!test
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4070 %! s.a = 1;
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4071 %! assert (iscolumn (s));
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4072
22737 7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22708 diff changeset	4073 ## Test input validation
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4074 %!error iscolumn ()
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4075 %!error iscolumn ([1, 2], 2)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4076 */
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4077
4028 ef75c970c8f5 [project @ 2002-08-09 07:19:02 by jwe] jwe parents: 4025 diff changeset	4078 DEFUN (ismatrix, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4079 doc: /* -- texinfo --
30559 841a10208c38 doc: Use TF for output variable in documentation for isXXX functions in libinterp/ directory. Rik <rik@octave.org> parents: 30402 diff changeset	4080 @deftypefn {} {@var{tf} =} ismatrix (@var{x})
28043 711cf9b1be49 doc: Reword isscalar, isvector, isrow, iscolumn, ismatrix, issquare docstrings. Rik <rik@octave.org> parents: 28012 diff changeset	4081 Return true if @var{x} is a 2-D array.
711cf9b1be49 doc: Reword isscalar, isvector, isrow, iscolumn, ismatrix, issquare docstrings. Rik <rik@octave.org> parents: 28012 diff changeset	4082
33029 0b8f3470d1fb doc: Clarify object types for isX functions (bug #48088) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 33018 diff changeset	4083 A matrix is an array of any type where @code{ndims (@var{x}) == 2} and for
28043 711cf9b1be49 doc: Reword isscalar, isvector, isrow, iscolumn, ismatrix, issquare docstrings. Rik <rik@octave.org> parents: 28012 diff changeset	4084 which @code{size (@var{x})} returns @w{@code{[M, N]}} with non-negative M and
711cf9b1be49 doc: Reword isscalar, isvector, isrow, iscolumn, ismatrix, issquare docstrings. Rik <rik@octave.org> parents: 28012 diff changeset	4085 N.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4086 @seealso{isscalar, isvector, iscell, isstruct, issparse, isa}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4087 @end deftypefn */)
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	4088 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	4089 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	4090 print_usage ();
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	4091
25917 ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	4092 // This function must use size() to determine the desired values to be
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	4093 // compatible with Matlab and to allow user-defined class overloading.
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	4094 Matrix sz = octave_value (args(0)).size ();
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	4095
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	4096 return ovl (sz.numel () == 2 && sz(0) >= 0 && sz(1) >= 0);
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	4097 }
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	4098
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4099 /*
19700 00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4100 %!assert (ismatrix ([]), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4101 %!assert (ismatrix (1), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4102 %!assert (ismatrix ([1, 2, 3]), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4103 %!assert (ismatrix ([1, 2; 3, 4]), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4104
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4105 %!assert (ismatrix (zeros (0)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4106 %!assert (ismatrix (zeros (0, 0)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4107 %!assert (ismatrix (zeros (0, 0, 0)), false)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4108 %!assert (ismatrix (zeros (3, 2, 4)), false)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4109
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4110 %!assert (ismatrix (single ([])), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4111 %!assert (ismatrix (single (1)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4112 %!assert (ismatrix (single ([1, 2, 3])), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4113 %!assert (ismatrix (single ([1, 2; 3, 4])), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4114
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4115 %!assert (ismatrix ("t"), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4116 %!assert (ismatrix ("test"), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4117 %!assert (ismatrix (["test"; "ing"]), true)
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4118
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4119 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4120 %! s.a = 1;
19700 00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19697 diff changeset	4121 %! assert (ismatrix (s), true);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4122
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4123 %!error ismatrix ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4124 %!error ismatrix ([1, 2; 3, 4], 2)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4125 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4126
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4127 DEFUN (issquare, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4128 doc: /* -- texinfo --
30559 841a10208c38 doc: Use TF for output variable in documentation for isXXX functions in libinterp/ directory. Rik <rik@octave.org> parents: 30402 diff changeset	4129 @deftypefn {} {@var{tf} =} issquare (@var{x})
28043 711cf9b1be49 doc: Reword isscalar, isvector, isrow, iscolumn, ismatrix, issquare docstrings. Rik <rik@octave.org> parents: 28012 diff changeset	4130 Return true if @var{x} is a 2-D square array.
711cf9b1be49 doc: Reword isscalar, isvector, isrow, iscolumn, ismatrix, issquare docstrings. Rik <rik@octave.org> parents: 28012 diff changeset	4131
33029 0b8f3470d1fb doc: Clarify object types for isX functions (bug #48088) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 33018 diff changeset	4132 A square array is a 2-D array of any type for which @code{size (@var{x})}
0b8f3470d1fb doc: Clarify object types for isX functions (bug #48088) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 33018 diff changeset	4133 returns @w{@code{[N, N]}} where N is a non-negative integer.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4134 @seealso{isscalar, isvector, ismatrix, size}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4135 @end deftypefn */)
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4136 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	4137 if (args.length () != 1)
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4138 print_usage ();
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4139
25917 ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	4140 // This function must use size() to determine the desired values to
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	4141 // allow user-defined class overloading.
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	4142 Matrix sz = octave_value (args(0)).size ();
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	4143
ba937c3dce82 Determine an object's shape by "size" (bug #51308, bug #44498, bug #43925). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25861 diff changeset	4144 return ovl (sz.numel () == 2 && sz(0) == sz(1));
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4145 }
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4146
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4147 /*
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4148 %!assert (issquare ([]))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4149 %!assert (issquare (1))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4150 %!assert (! issquare ([1, 2]))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4151 %!assert (issquare ([1, 2; 3, 4]))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4152 %!assert (! issquare ([1, 2; 3, 4; 5, 6]))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4153 %!assert (! issquare (ones (3,3,3)))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4154 %!assert (issquare ("t"))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4155 %!assert (! issquare ("test"))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4156 %!assert (issquare (["test"; "ing"; "1"; "2"]))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4157 %!test
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4158 %! s.a = 1;
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4159 %! assert (issquare (s));
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4160 %!assert (issquare ({1, 2; 3, 4}))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4161 %!assert (sparse (([1, 2; 3, 4])))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4162
22737 7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22708 diff changeset	4163 ## Test input validation
18814 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4164 %!error issquare ()
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4165 %!error issquare ([1, 2; 3, 4], 2)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4166 */
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18813 diff changeset	4167
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	4168 static octave_value
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4169 fill_matrix (const octave_value_list& args, int val, const char *fcn)
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4170 {
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	4171 octave_value retval;
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4172
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4173 int nargin = args.length ();
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4174
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4175 oct_data_conv::data_type dt = oct_data_conv::dt_double;
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4176
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4177 dim_vector dims (1, 1);
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4178 bool issparse = false;
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4179 bool iscomplex = false;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4180
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4181 if (nargin > 0 && args(nargin-1).is_string ())
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4182 {
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4183 std::string nm = args(nargin-1).string_value ();
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4184 nargin--;
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4185
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4186 dt = oct_data_conv::string_to_data_type (nm);
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4187 }
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4188
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4189 if (nargin > 1 && args(nargin-2).is_string ()
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4190 && args(nargin-2).string_value () == "like")
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4191 {
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4192 std::string nm = args(nargin-1).class_name ();
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4193 issparse = args(nargin-1).issparse ();
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4194 iscomplex = args(nargin-1).iscomplex ();
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4195 nargin -= 2;
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4196 dt = oct_data_conv::string_to_data_type (nm);
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4197 }
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4198
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4199 switch (nargin)
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4200 {
712 36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	4201 case 0:
36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	4202 break;
777 a2f9d3fd720c [project @ 1994-10-07 14:01:53 by jwe] jwe parents: 767 diff changeset	4203
610 14b2a186a5c0 [project @ 1994-08-14 00:55:49 by jwe] jwe parents: 597 diff changeset	4204 case 1:
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	4205 get_dimensions (args(0), fcn, dims);
610 14b2a186a5c0 [project @ 1994-08-14 00:55:49 by jwe] jwe parents: 597 diff changeset	4206 break;
777 a2f9d3fd720c [project @ 1994-10-07 14:01:53 by jwe] jwe parents: 767 diff changeset	4207
4563 742993a501b9 [project @ 2003-10-29 06:25:12 by jwe] jwe parents: 4559 diff changeset	4208 default:
742993a501b9 [project @ 2003-10-29 06:25:12 by jwe] jwe parents: 4559 diff changeset	4209 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4210 dims.resize (nargin);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4211
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4212 for (int i = 0; i < nargin; i++)
30934 d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4213 {
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4214 if (args(i).numel () > 1)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4215 error ("%s: dimensions must be scalars.", fcn);
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4216
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4217 dims(i) = (args(i).isempty () ? 0 : args(i).idx_type_value (true));
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4218 }
4563 742993a501b9 [project @ 2003-10-29 06:25:12 by jwe] jwe parents: 4559 diff changeset	4219 }
742993a501b9 [project @ 2003-10-29 06:25:12 by jwe] jwe parents: 4559 diff changeset	4220 break;
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4221 }
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4222
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4223 dims.chop_trailing_singletons ();
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4224
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	4225 check_dimensions (dims, fcn);
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4226
25926 373fe1608f7c Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension (bug #54781). Rik <rik@octave.org> parents: 25917 diff changeset	4227 // FIXME: Perhaps this should be made extensible by using the class name
373fe1608f7c Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension (bug #54781). Rik <rik@octave.org> parents: 25917 diff changeset	4228 // to lookup a function to call to create the new value.
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4229
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4230 // Note that automatic narrowing will handle conversion from
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4231 // NDArray to scalar.
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4232
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4233 if (issparse)
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4234 {
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4235 if (dims.ndims () > 2)
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4236 error ("%s: sparse ND arrays not supported.", fcn);
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4237
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4238 switch (dt)
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4239 {
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4240 case oct_data_conv::dt_double:
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4241 if (iscomplex)
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4242 retval = SparseComplexMatrix (dims(0), dims(1), Complex (val, 0));
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4243 else
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4244 retval = SparseMatrix (dims(0), dims(1), static_cast<double> (val));
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4245 break;
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4246
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4247 case oct_data_conv::dt_logical:
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4248 retval = SparseBoolMatrix (dims(0), dims(1), static_cast<bool> (val));
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4249 break;
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4250
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4251 default:
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4252 // FIXME: It shouldn't be possible to ever reach this.
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4253 error ("%s: invalid class name for sparse", fcn);
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4254 }
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4255
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4256 return retval;
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4257 }
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4258
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4259 switch (dt)
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4260 {
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4261 case oct_data_conv::dt_int8:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4262 retval = int8NDArray (dims, val);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4263 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4264
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4265 case oct_data_conv::dt_uint8:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4266 retval = uint8NDArray (dims, val);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4267 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4268
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4269 case oct_data_conv::dt_int16:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4270 retval = int16NDArray (dims, val);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4271 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4272
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4273 case oct_data_conv::dt_uint16:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4274 retval = uint16NDArray (dims, val);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4275 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4276
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4277 case oct_data_conv::dt_int32:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4278 retval = int32NDArray (dims, val);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4279 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4280
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4281 case oct_data_conv::dt_uint32:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4282 retval = uint32NDArray (dims, val);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4283 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4284
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4285 case oct_data_conv::dt_int64:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4286 retval = int64NDArray (dims, val);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4287 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4288
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4289 case oct_data_conv::dt_uint64:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4290 retval = uint64NDArray (dims, val);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4291 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4292
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4293 case oct_data_conv::dt_single:
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4294 if (iscomplex)
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4295 retval = FloatComplexNDArray (dims, val);
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4296 else
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4297 retval = FloatNDArray (dims, val);
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4298 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4299
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4300 case oct_data_conv::dt_double:
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4301 if (iscomplex)
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4302 retval = ComplexNDArray (dims, Complex (val, 0));
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4303 else
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4304 retval = NDArray (dims, val);
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4305 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4306
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4307 case oct_data_conv::dt_logical:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4308 retval = boolNDArray (dims, val);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4309 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4310
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4311 default:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4312 error ("%s: invalid class name", fcn);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4313 break;
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4314 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4315
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4316 return retval;
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4317 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4318
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4319 static octave_value
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4320 fill_matrix (const octave_value_list& args, double val, float fval,
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4321 const char *fcn)
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4322 {
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4323 octave_value retval;
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4324
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4325 int nargin = args.length ();
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4326
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4327 oct_data_conv::data_type dt = oct_data_conv::dt_double;
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4328
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4329 dim_vector dims (1, 1);
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4330 bool issparse = false;
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4331 bool iscomplex = false;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4332
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4333 if (nargin > 0 && args(nargin-1).is_string ())
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4334 {
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4335 std::string nm = args(nargin-1).string_value ();
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4336 nargin--;
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4337
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4338 dt = oct_data_conv::string_to_data_type (nm);
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4339 }
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4340
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4341 if (nargin > 1 && args(nargin-2).is_string ()
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4342 && args(nargin-2).string_value () == "like"
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4343 && (std::string(fcn) == "Inf"
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4344 \|\| std::string(fcn) == "NaN" \|\| std::string(fcn) == "NA"))
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4345 {
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4346 if (! args(nargin-1).isfloat ())
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4347 error ("%s: input followed by 'like' must be floating point", fcn);
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4348 std::string nm = args(nargin-1).class_name ();
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4349 issparse = args(nargin-1).issparse ();
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4350 iscomplex = args(nargin-1).iscomplex ();
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4351 nargin -= 2;
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4352 dt = oct_data_conv::string_to_data_type (nm);
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4353 }
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4354
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4355 switch (nargin)
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4356 {
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4357 case 0:
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4358 break;
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4359
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4360 case 1:
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	4361 get_dimensions (args(0), fcn, dims);
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4362 break;
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4363
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4364 default:
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4365 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4366 dims.resize (nargin);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4367
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4368 for (int i = 0; i < nargin; i++)
30934 d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4369 {
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4370 if (args(i).numel () > 1)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4371 error ("%s: dimensions must be scalars.", fcn);
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4372
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4373 dims(i) = (args(i).isempty () ? 0 : args(i).idx_type_value (true));
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4374 }
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4375 }
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4376 break;
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4377 }
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4378
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4379 dims.chop_trailing_singletons ();
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4380
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	4381 check_dimensions (dims, fcn);
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4382
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4383 // Note that automatic narrowing will handle conversion from
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4384 // NDArray to scalar.
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4385
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4386 if (issparse)
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4387 {
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4388 if (dims.ndims () > 2)
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4389 error ("%s: sparse ND arrays not supported", fcn);
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4390
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4391 if (iscomplex)
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4392 retval = SparseComplexMatrix (dims(0), dims(1), Complex (val, 0));
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4393 else
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4394 retval = SparseMatrix (dims(0), dims(1), static_cast<double> (val));
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4395
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4396 return retval;
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4397 }
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4398
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4399 switch (dt)
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4400 {
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4401 case oct_data_conv::dt_single:
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4402 if (iscomplex)
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4403 retval = FloatComplexNDArray (dims, fval);
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4404 else
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4405 retval = FloatNDArray (dims, fval);
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4406 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4407
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4408 case oct_data_conv::dt_double:
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4409 if (iscomplex)
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4410 retval = ComplexNDArray (dims, Complex (val, 0));
27568 e78b6e7f743c Store constant row vectors for ones(), zeros(), pi(), e() as Ranges for compactness. Rik <rik@octave.org> parents: 27435 diff changeset	4411 else
e78b6e7f743c Store constant row vectors for ones(), zeros(), pi(), e() as Ranges for compactness. Rik <rik@octave.org> parents: 27435 diff changeset	4412 retval = NDArray (dims, val);
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4413 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4414
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4415 default:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4416 error ("%s: invalid class name", fcn);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4417 break;
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4418 }
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4419
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4420 return retval;
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4421 }
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4422
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4423 static octave_value
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4424 fill_matrix (const octave_value_list& args, double val, const char *fcn)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4425 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4426 octave_value retval;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4427
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4428 int nargin = args.length ();
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4429
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4430 oct_data_conv::data_type dt = oct_data_conv::dt_double;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4431
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4432 dim_vector dims (1, 1);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4433
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4434 if (nargin > 0 && args(nargin-1).is_string ())
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4435 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4436 std::string nm = args(nargin-1).string_value ();
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4437 nargin--;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4438
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4439 dt = oct_data_conv::string_to_data_type (nm);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4440 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4441
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4442 switch (nargin)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4443 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4444 case 0:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4445 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4446
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4447 case 1:
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	4448 get_dimensions (args(0), fcn, dims);
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4449 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4450
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4451 default:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4452 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4453 dims.resize (nargin);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4454
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4455 for (int i = 0; i < nargin; i++)
30934 d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4456 {
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4457 if (args(i).numel () > 1)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4458 error ("%s: dimensions must be scalars.", fcn);
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4459
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4460 dims(i) = (args(i).isempty () ? 0 : args(i).idx_type_value (true));
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4461 }
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4462 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4463 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4464 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4465
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4466 dims.chop_trailing_singletons ();
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4467
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	4468 check_dimensions (dims, fcn);
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4469
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4470 // Note that automatic narrowing will handle conversion from
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4471 // NDArray to scalar.
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4472
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4473 switch (dt)
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4474 {
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4475 case oct_data_conv::dt_single:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4476 retval = FloatNDArray (dims, static_cast<float> (val));
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4477 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4478
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4479 case oct_data_conv::dt_double:
30853 fc3bd70cd1be eliminate range<T>::make_constant function John W. Eaton <jwe@octave.org> parents: 30564 diff changeset	4480 retval = NDArray (dims, val);
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4481 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4482
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4483 default:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4484 error ("%s: invalid class name", fcn);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4485 break;
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4486 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4487
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4488 return retval;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4489 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4490
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4491 static octave_value
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4492 fill_matrix (const octave_value_list& args, const Complex& val,
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4493 const char *fcn)
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4494 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4495 octave_value retval;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4496
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4497 int nargin = args.length ();
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4498
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4499 oct_data_conv::data_type dt = oct_data_conv::dt_double;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4500
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4501 dim_vector dims (1, 1);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4502
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4503 if (nargin > 0 && args(nargin-1).is_string ())
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4504 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4505 std::string nm = args(nargin-1).string_value ();
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4506 nargin--;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4507
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4508 dt = oct_data_conv::string_to_data_type (nm);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4509 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4510
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4511 switch (nargin)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4512 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4513 case 0:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4514 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4515
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4516 case 1:
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	4517 get_dimensions (args(0), fcn, dims);
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4518 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4519
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4520 default:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4521 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4522 dims.resize (nargin);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4523
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4524 for (int i = 0; i < nargin; i++)
30934 d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4525 {
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4526 if (args(i).numel () > 1)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4527 error ("%s: dimensions must be scalars.", fcn);
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4528
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4529 dims(i) = (args(i).isempty () ? 0 : args(i).idx_type_value (true));
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4530 }
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4531 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4532 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4533 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4534
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4535 dims.chop_trailing_singletons ();
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4536
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	4537 check_dimensions (dims, fcn);
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4538
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4539 // Note that automatic narrowing will handle conversion from
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4540 // NDArray to scalar.
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4541
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4542 switch (dt)
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4543 {
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4544 case oct_data_conv::dt_single:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4545 retval = FloatComplexNDArray (dims,
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4546 static_cast<FloatComplex> (val));
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4547 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4548
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4549 case oct_data_conv::dt_double:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4550 retval = ComplexNDArray (dims, val);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4551 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4552
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4553 default:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4554 error ("%s: invalid class name", fcn);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4555 break;
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4556 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4557
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4558 return retval;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4559 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4560
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4561 static octave_value
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4562 fill_matrix (const octave_value_list& args, bool val, const char *fcn)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4563 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4564 octave_value retval;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4565
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4566 int nargin = args.length ();
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4567
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4568 dim_vector dims (1, 1);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4569
28115 de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	4570 // The TYPE argument is required to be "logical" if present. This
de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	4571 // feature appears to be undocumented in Matlab.
de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	4572
de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	4573 if (nargin > 0 && args(nargin-1).is_string ())
de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	4574 {
de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	4575 std::string nm = args(nargin-1).string_value ();
de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	4576 nargin--;
de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	4577
de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	4578 if (oct_data_conv::string_to_data_type (nm) != oct_data_conv::dt_logical)
de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	4579 error ("%s: invalid data type '%s'", fcn, nm.c_str ());
de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	4580 }
de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	4581
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4582 bool issparse = false;
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4583
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4584 if (nargin > 1 && args(nargin-2).is_string ()
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4585 && args(nargin-2).string_value () == "like")
30390 a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30377 diff changeset	4586 {
a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30377 diff changeset	4587 if (! args(nargin-1).islogical ())
a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30377 diff changeset	4588 error (R"(%s: input followed by "like" must be logical)", fcn);
a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30377 diff changeset	4589
a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30377 diff changeset	4590 issparse = args(nargin-1).issparse ();
a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30377 diff changeset	4591 nargin -= 2;
a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30377 diff changeset	4592 }
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4593
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4594 switch (nargin)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4595 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4596 case 0:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4597 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4598
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4599 case 1:
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	4600 get_dimensions (args(0), fcn, dims);
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4601 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4602
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4603 default:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4604 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4605 dims.resize (nargin);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4606
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4607 for (int i = 0; i < nargin; i++)
30934 d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4608 {
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4609 if (args(i).numel () > 1)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4610 error ("%s: dimensions must be scalars.", fcn);
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4611
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4612 dims(i) = (args(i).isempty () ? 0 : args(i).idx_type_value (true));
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4613 }
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4614 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4615 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4616 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4617
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4618 dims.chop_trailing_singletons ();
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4619
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	4620 check_dimensions (dims, fcn);
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4621
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4622 // Note that automatic narrowing will handle conversion from
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4623 // NDArray to scalar.
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	4624
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4625 if (issparse)
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4626 {
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4627 if (dims.ndims () > 2)
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4628 error ("%s: sparse ND arrays not supported", fcn);
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4629
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4630 retval = SparseBoolMatrix (dims(0), dims(1), val);
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4631 }
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4632 else
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4633 retval = boolNDArray (dims, val);
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4634
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4635 return retval;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4636 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4637
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	4638 DEFUN (ones, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4639 doc: /* -- texinfo --
29218 8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4640 @deftypefn {} {@var{val} =} ones (@var{n})
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4641 @deftypefnx {} {@var{val} =} ones (@var{m}, @var{n})
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4642 @deftypefnx {} {@var{val} =} ones (@var{m}, @var{n}, @var{k}, @dots{})
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4643 @deftypefnx {} {@var{val} =} ones ([@var{m} @var{n} @dots{}])
31611 535492e34f8f doc: Don't use TexInfo @var{} macro "like" for zeros, ones, etc. Rik <rik@octave.org> parents: 31607 diff changeset	4644 @deftypefnx {} {@var{val} =} ones (@dots{}, "like", @var{var})
29218 8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4645 @deftypefnx {} {@var{val} =} ones (@dots{}, @var{class})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4646 Return a matrix or N-dimensional array whose elements are all 1.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4647
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4648 If invoked with a single scalar integer argument @var{n}, return a square
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4649 @nospell{NxN} matrix.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4650
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4651 If invoked with two or more scalar integer arguments, or a vector of integer
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4652 values, return an array with the given dimensions.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4653
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4654 To create a constant matrix whose values are all the same use an expression
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4655 such as
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4656
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4657 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4658 val_matrix = val * ones (m, n)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4659 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4660
29218 8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4661 If a variable @var{var} is specified after @qcode{"like"}, the output @var{val}
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4662 will have the same data type, complexity, and sparsity as @var{var}.
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4663
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4664 The optional argument @var{class} specifies the class of the return array
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4665 and defaults to double. For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4666
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4667 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4668 val = ones (m,n, "uint8")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4669 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4670 @seealso{zeros}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4671 @end deftypefn */)
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4672 {
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4673 return fill_matrix (args, 1, "ones");
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4674 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4675
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4676 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4677 %!assert (ones (3), [1, 1, 1; 1, 1, 1; 1, 1, 1])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4678 %!assert (ones (2, 3), [1, 1, 1; 1, 1, 1])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4679 %!assert (ones (3, 2), [1, 1; 1, 1; 1, 1])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4680 %!assert (size (ones (3, 4, 5)), [3, 4, 5])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4681
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4682 %!assert (ones (3, "single"), single ([1, 1, 1; 1, 1, 1; 1, 1, 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4683 %!assert (ones (2, 3, "single"), single ([1, 1, 1; 1, 1, 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4684 %!assert (ones (3, 2, "single"), single ([1, 1; 1, 1; 1, 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4685 %!assert (size (ones (3, 4, 5, "single")), [3, 4, 5])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4686
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4687 %!assert (ones (3, "int8"), int8 ([1, 1, 1; 1, 1, 1; 1, 1, 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4688 %!assert (ones (2, 3, "int8"), int8 ([1, 1, 1; 1, 1, 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4689 %!assert (ones (3, 2, "int8"), int8 ([1, 1; 1, 1; 1, 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4690 %!assert (size (ones (3, 4, 5, "int8")), [3, 4, 5])
25926 373fe1608f7c Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension (bug #54781). Rik <rik@octave.org> parents: 25917 diff changeset	4691
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4692 %!assert (ones (2, 2, "like", double (1)), double ([1, 1; 1, 1]))
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4693 %!assert (ones (2, 2, "like", complex (ones (2, 2))), [1, 1; 1, 1])
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4694 %!assert (ones (1, 2, "like", single (1)), single ([1, 1]))
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4695 %!assert (ones (1, "like", single (1i)), single (1))
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4696 %!assert (ones (2, 2, "like", uint8 (8)), uint8 ([1, 1; 1, 1]))
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4697 %!assert (ones (2, "like", speye (2)), sparse ([1, 1; 1, 1]))
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4698 %!assert (ones (2, "like", sparse (1i)), sparse (complex ([1, 1; 1, 1])))
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4699
32060 1203a2d81a42 Add BIST tests for Matlab compatibility for functions which accept negative dimensions. Rik <rik@octave.org> parents: 32046 diff changeset	4700 ## Note: Matlab compatibility requires using 0 for negative dimensions.
25926 373fe1608f7c Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension (bug #54781). Rik <rik@octave.org> parents: 25917 diff changeset	4701 %!assert (size (ones (1, -2, 2)), [1, 0, 2])
25928 a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	4702
a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	4703 ## Test input validation
a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	4704 %!error <conversion of 1.1 .*failed> ones (1.1)
a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	4705 %!error <conversion of 1.1 .*failed> ones (1, 1.1)
a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	4706 %!error <conversion of 1.1 .*failed> ones ([1, 1.1])
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4707 %!error <sparse ND .* not supported> ones (3, 3, 3, "like", speye (1))
30934 d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4708 %!error <must be scalar> ones (1:3, 1)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4709 %!error <must be scalar> ones (1, 1:3)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4710 %!error <must be scalar> ones (1, 2, 1:3)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4711 %!error <must be scalar> ones (1:3, 1, "like", single (1))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4712 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4713
21405 120bb822c6f4 Handle empty vectors for size of ones(), zeros(), inf(), etc... (bug #47298) Carnë Draug <carandraug@octave.org> parents: 21317 diff changeset	4714 /*
120bb822c6f4 Handle empty vectors for size of ones(), zeros(), inf(), etc... (bug #47298) Carnë Draug <carandraug@octave.org> parents: 21317 diff changeset	4715 ## Tests for bug #47298
120bb822c6f4 Handle empty vectors for size of ones(), zeros(), inf(), etc... (bug #47298) Carnë Draug <carandraug@octave.org> parents: 21317 diff changeset	4716 ## Matlab requires the size to be a row vector. In that logic, it supports
120bb822c6f4 Handle empty vectors for size of ones(), zeros(), inf(), etc... (bug #47298) Carnë Draug <carandraug@octave.org> parents: 21317 diff changeset	4717 ## n to be a 1x0 vector (returns 0x0) but not a 0x1 vector. Octave supports
31278 076c8f94d7f4 Allow empty input for dimension vector (bug #63181). Markus Mützel <markus.muetzel@gmx.de> parents: 31141 diff changeset	4718 ## row and column vectors and therefore must support 0x1, 1x0, and 0x1x1.
076c8f94d7f4 Allow empty input for dimension vector (bug #63181). Markus Mützel <markus.muetzel@gmx.de> parents: 31141 diff changeset	4719 ## Also any empty input results in a 0x0 output.
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	4720 %!test <*47298>
30896 c9788d7f6e65 maint: Use "fcn" as preferred abbreviation for "function" in libinterp/. Rik <rik@octave.org> parents: 30892 diff changeset	4721 %! fcns = {@zeros, @ones, @inf, @nan, @NA, @i, @pi, @e};
c9788d7f6e65 maint: Use "fcn" as preferred abbreviation for "function" in libinterp/. Rik <rik@octave.org> parents: 30892 diff changeset	4722 %! for idx = 1:numel (fcns)
c9788d7f6e65 maint: Use "fcn" as preferred abbreviation for "function" in libinterp/. Rik <rik@octave.org> parents: 30892 diff changeset	4723 %! fcn = fcns{idx};
c9788d7f6e65 maint: Use "fcn" as preferred abbreviation for "function" in libinterp/. Rik <rik@octave.org> parents: 30892 diff changeset	4724 %! assert (fcn (zeros (1, 0)), zeros (0, 0));
c9788d7f6e65 maint: Use "fcn" as preferred abbreviation for "function" in libinterp/. Rik <rik@octave.org> parents: 30892 diff changeset	4725 %! assert (fcn (zeros (0, 1)), zeros (0, 0));
c9788d7f6e65 maint: Use "fcn" as preferred abbreviation for "function" in libinterp/. Rik <rik@octave.org> parents: 30892 diff changeset	4726 %! assert (fcn (zeros (0, 1, 1)), zeros (0, 0));
31278 076c8f94d7f4 Allow empty input for dimension vector (bug #63181). Markus Mützel <markus.muetzel@gmx.de> parents: 31141 diff changeset	4727 %! assert (fcn (zeros ([])), zeros (0, 0));
076c8f94d7f4 Allow empty input for dimension vector (bug #63181). Markus Mützel <markus.muetzel@gmx.de> parents: 31141 diff changeset	4728 %! assert (fcn (zeros (0, 0, 1)), zeros (0, 0));
21405 120bb822c6f4 Handle empty vectors for size of ones(), zeros(), inf(), etc... (bug #47298) Carnë Draug <carandraug@octave.org> parents: 21317 diff changeset	4729 %! endfor
120bb822c6f4 Handle empty vectors for size of ones(), zeros(), inf(), etc... (bug #47298) Carnë Draug <carandraug@octave.org> parents: 21317 diff changeset	4730 */
120bb822c6f4 Handle empty vectors for size of ones(), zeros(), inf(), etc... (bug #47298) Carnë Draug <carandraug@octave.org> parents: 21317 diff changeset	4731
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	4732 DEFUN (zeros, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4733 doc: /* -- texinfo --
29218 8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4734 @deftypefn {} {@var{val} =} zeros (@var{n})
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4735 @deftypefnx {} {@var{val} =} zeros (@var{m}, @var{n})
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4736 @deftypefnx {} {@var{val} =} zeros (@var{m}, @var{n}, @var{k}, @dots{})
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4737 @deftypefnx {} {@var{val} =} zeros ([@var{m} @var{n} @dots{}])
31611 535492e34f8f doc: Don't use TexInfo @var{} macro "like" for zeros, ones, etc. Rik <rik@octave.org> parents: 31607 diff changeset	4738 @deftypefnx {} {@var{val} =} zeros (@dots{}, "like", @var{var})
29218 8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4739 @deftypefnx {} {@var{val} =} zeros (@dots{}, @var{class})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4740 Return a matrix or N-dimensional array whose elements are all 0.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4741
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4742 If invoked with a single scalar integer argument, return a square
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4743 @nospell{NxN} matrix.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4744
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4745 If invoked with two or more scalar integer arguments, or a vector of integer
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4746 values, return an array with the given dimensions.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4747
29218 8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4748 If a variable @var{var} is specified after @qcode{"like"}, the output @var{val}
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4749 will have the same data type, complexity, and sparsity as @var{var}.
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4750
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4751 The optional argument @var{class} specifies the class of the return array
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4752 and defaults to double. For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4753
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4754 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4755 val = zeros (m,n, "uint8")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4756 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4757 @seealso{ones}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4758 @end deftypefn */)
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4759 {
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4760 return fill_matrix (args, 0, "zeros");
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4761 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4762
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4763 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4764 %!assert (zeros (3), [0, 0, 0; 0, 0, 0; 0, 0, 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4765 %!assert (zeros (2, 3), [0, 0, 0; 0, 0, 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4766 %!assert (zeros (3, 2), [0, 0; 0, 0; 0, 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4767 %!assert (size (zeros (3, 4, 5)), [3, 4, 5])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4768
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4769 %!assert (zeros (2, 2, "like", double (1)), double ([0, 0; 0, 0]))
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4770 %!assert (zeros (2, 2, "like", complex (ones (2, 2))), [0, 0; 0, 0])
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4771 %!assert (zeros (1, 2, "like", single (1)), single ([0, 0]))
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4772 %!assert (zeros (1, 2, "like", single (1i)), single ([0, 0]))
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4773 %!assert (zeros (2, 2, "like", uint8 (8)), uint8 ([0, 0; 0, 0]))
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4774 %!assert (zeros (2, "like", speye (2)), sparse ([0, 0; 0, 0]))
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4775
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4776 %!assert (zeros (3, "single"), single ([0, 0, 0; 0, 0, 0; 0, 0, 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4777 %!assert (zeros (2, 3, "single"), single ([0, 0, 0; 0, 0, 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4778 %!assert (zeros (3, 2, "single"), single ([0, 0; 0, 0; 0, 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4779 %!assert (size (zeros (3, 4, 5, "single")), [3, 4, 5])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4780
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4781 %!assert (zeros (3, "int8"), int8 ([0, 0, 0; 0, 0, 0; 0, 0, 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4782 %!assert (zeros (2, 3, "int8"), int8 ([0, 0, 0; 0, 0, 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4783 %!assert (zeros (3, 2, "int8"), int8 ([0, 0; 0, 0; 0, 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4784 %!assert (size (zeros (3, 4, 5, "int8")), [3, 4, 5])
25928 a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	4785
a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	4786 ## Test input validation
a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	4787 %!error <invalid data type specified> zeros (1, 1, "foobar")
a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	4788 %!error <conversion of 1.1 .*failed> zeros (1.1)
a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	4789 %!error <conversion of 1.1 .*failed> zeros (1, 1.1)
a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	4790 %!error <conversion of 1.1 .*failed> zeros ([1, 1.1])
a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	4791 %!error <conversion of 1.1 .*failed> zeros (1, 1.1, 2)
a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	4792 %!error <conversion of 1.1 .*failed> zeros ([1, 1.1, 2])
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4793 %!error <sparse ND .* not supported> zeros (3, 3, 3, "like", speye (1))
30934 d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4794 %!error <must be scalar> zeros (1:3, 1)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4795 %!error <must be scalar> zeros (1, 1:3)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4796 %!error <must be scalar> zeros (1, 2, 1:3)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4797 %!error <must be scalar> zeros (1:3, 1, "like", single (1))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4798 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4799
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4800 DEFUN (Inf, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4801 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4802 @c List other form of function in documentation index
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4803 @findex inf
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4804
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	4805 @deftypefn {} {@var{A} =} Inf
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	4806 @deftypefnx {} {@var{A} =} Inf (@var{n})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	4807 @deftypefnx {} {@var{A} =} Inf (@var{n}, @var{m})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	4808 @deftypefnx {} {@var{A} =} Inf (@var{n}, @var{m}, @var{k}, @dots{})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	4809 @deftypefnx {} {@var{A} =} Inf (@dots{}, @var{class})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4810 Return a scalar, matrix or N-dimensional array whose elements are all equal
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4811 to the IEEE representation for positive infinity.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4812
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4813 Infinity is produced when results are too large to be represented using the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4814 IEEE floating point format for numbers. Two common examples which produce
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4815 infinity are division by zero and overflow.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4816
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4817 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4818 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4819 [ 1/0 e^800 ]
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4820 @result{} Inf Inf
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4821 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4822 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4823
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4824 When called with no arguments, return a scalar with the value @samp{Inf}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4825
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4826 When called with a single argument, return a square matrix with the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4827 dimension specified.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4828
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4829 When called with more than one scalar argument the first two arguments are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4830 taken as the number of rows and columns and any further arguments specify
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4831 additional matrix dimensions.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4832
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4833 The optional argument @var{class} specifies the return type and may be
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4834 either @qcode{"double"} or @qcode{"single"}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4835 @seealso{isinf, NaN}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4836 @end deftypefn */)
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4837 {
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4838 return fill_matrix (args, lo_ieee_inf_value (),
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4839 lo_ieee_float_inf_value (), "Inf");
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4840 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4841
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4842 DEFALIAS (inf, Inf);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4843
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4844 /*
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4845 %!assert (Inf (3), [Inf, Inf, Inf; Inf, Inf, Inf; Inf, Inf, Inf])
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4846 %!assert (Inf (2, 3), [Inf, Inf, Inf; Inf, Inf, Inf])
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4847 %!assert (Inf (3, 2), [Inf, Inf; Inf, Inf; Inf, Inf])
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4848 %!assert (size (Inf (3, 4, 5)), [3, 4, 5])
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4849
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	4850 %!assert (Inf (3, "single"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	4851 %! single ([Inf, Inf, Inf; Inf, Inf, Inf; Inf, Inf, Inf]))
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4852 %!assert (Inf (2, 3, "single"), single ([Inf, Inf, Inf; Inf, Inf, Inf]))
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4853 %!assert (Inf (3, 2, "single"), single ([Inf, Inf; Inf, Inf; Inf, Inf]))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4854 %!assert (size (inf (3, 4, 5, "single")), [3, 4, 5])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4855
32060 1203a2d81a42 Add BIST tests for Matlab compatibility for functions which accept negative dimensions. Rik <rik@octave.org> parents: 32046 diff changeset	4856 ## Note: Matlab compatibility requires using 0 for negative dimensions.
1203a2d81a42 Add BIST tests for Matlab compatibility for functions which accept negative dimensions. Rik <rik@octave.org> parents: 32046 diff changeset	4857 %!assert (size (Inf (2, -3, 2)), [2, 0, 2])
1203a2d81a42 Add BIST tests for Matlab compatibility for functions which accept negative dimensions. Rik <rik@octave.org> parents: 32046 diff changeset	4858
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4859 %!assert (Inf (2, 2, "like", speye (2)), sparse ([Inf, Inf; Inf, Inf]))
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4860 %!assert (Inf (2, 2, "like", complex (ones (2, 2))), [Inf, Inf; Inf, Inf])
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4861 %!assert (Inf (2, 2, "like", double (1)), double ([Inf, Inf; Inf, Inf]))
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	4862 %!assert (Inf (3, 3, "like", single (1)),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	4863 %! single ([Inf, Inf, Inf; Inf, Inf, Inf; Inf, Inf, Inf]))
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4864 %!assert (Inf (2, "like", single (1i)), single ([Inf, Inf; Inf, Inf]))
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4865
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4866 %!error Inf (3, "like", int8 (1))
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4867
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4868 %!error Inf (3, "int8")
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4869 %!error Inf (2, 3, "int8")
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4870 %!error Inf (3, 2, "int8")
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4871 %!error Inf (3, 4, 5, "int8")
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4872 %!error <input .* floating> Inf (3, 3, "like", true)
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4873 %!error <input .* floating> Inf (2, "like", uint8 (1))
30934 d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4874 %!error <must be scalar> Inf (1:3, 1)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4875 %!error <must be scalar> Inf (1, 1:3)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4876 %!error <must be scalar> Inf (1, 2, 1:3)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4877 %!error <must be scalar> Inf (1:3, 1, "like", single (1))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4878 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4879
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4880 DEFUN (NaN, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4881 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4882 @c List other form of function in documentation index
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4883 @findex nan
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4884
29218 8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4885 @deftypefn {} {@var{val} =} NaN
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4886 @deftypefnx {} {@var{val} =} NaN (@var{n})
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4887 @deftypefnx {} {@var{val} =} NaN (@var{n}, @var{m})
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4888 @deftypefnx {} {@var{val} =} NaN (@var{n}, @var{m}, @var{k}, @dots{})
31611 535492e34f8f doc: Don't use TexInfo @var{} macro "like" for zeros, ones, etc. Rik <rik@octave.org> parents: 31607 diff changeset	4889 @deftypefnx {} {@var{val} =} NaN (@dots{}, "like", @var{var})
29218 8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4890 @deftypefnx {} {@var{val} =} NaN (@dots{}, @var{class})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4891 Return a scalar, matrix, or N-dimensional array whose elements are all equal
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4892 to the IEEE symbol NaN (Not a Number).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4893
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4894 NaN is the result of operations which do not produce a well defined
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4895 numerical result. Common operations which produce a NaN are arithmetic
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4896 with infinity
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4897 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4898 ($\infty - \infty$), zero divided by zero ($0/0$),
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4899 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4900 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4901 (Inf - Inf), zero divided by zero (0/0),
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4902 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4903 and any operation involving another NaN value (5 + NaN).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4904
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4905 Note that NaN always compares not equal to NaN (NaN != NaN). This behavior
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4906 is specified by the IEEE standard for floating point arithmetic. To find
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4907 NaN values, use the @code{isnan} function.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4908
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4909 When called with no arguments, return a scalar with the value @samp{NaN}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4910
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4911 When called with a single argument, return a square matrix with the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4912 dimension specified.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4913
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4914 When called with more than one scalar argument the first two arguments are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4915 taken as the number of rows and columns and any further arguments specify
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4916 additional matrix dimensions.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4917
29218 8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4918 If a variable @var{var} is specified after @qcode{"like"}, the output @var{val}
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4919 will have the same data type, complexity, and sparsity as @var{var}.
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	4920
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4921 The optional argument @var{class} specifies the return type and may be
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4922 either @qcode{"double"} or @qcode{"single"}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4923 @seealso{isnan, Inf}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4924 @end deftypefn */)
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4925 {
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4926 return fill_matrix (args, lo_ieee_nan_value (),
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4927 lo_ieee_float_nan_value (), "NaN");
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4928 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4929
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4930 DEFALIAS (nan, NaN);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4931
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4932 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4933 %!assert (NaN (3), [NaN, NaN, NaN; NaN, NaN, NaN; NaN, NaN, NaN])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4934 %!assert (NaN (2, 3), [NaN, NaN, NaN; NaN, NaN, NaN])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4935 %!assert (NaN (3, 2), [NaN, NaN; NaN, NaN; NaN, NaN])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4936 %!assert (size (NaN (3, 4, 5)), [3, 4, 5])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4937
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	4938 %!assert (NaN (3, "single"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	4939 %! single ([NaN, NaN, NaN; NaN, NaN, NaN; NaN, NaN, NaN]))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4940 %!assert (NaN (2, 3, "single"), single ([NaN, NaN, NaN; NaN, NaN, NaN]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4941 %!assert (NaN (3, 2, "single"), single ([NaN, NaN; NaN, NaN; NaN, NaN]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4942 %!assert (size (NaN (3, 4, 5, "single")), [3, 4, 5])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4943
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4944 %!assert (NaN (2, 2, "like", double (1)), double ([NaN, NaN; NaN, NaN]))
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4945 %!assert (NaN (2, 2, "like", complex (ones(2, 2))), [NaN, NaN; NaN, NaN])
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	4946 %!assert (NaN (3, 3, "like", single (1)),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	4947 %! single ([NaN, NaN, NaN; NaN, NaN, NaN; NaN, NaN, NaN]))
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4948 %!assert (NaN (2, "like", single (1i)), single ([NaN, NaN; NaN, NaN]))
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4949 %!assert (NaN (2, 2, "like", speye (2)), sparse ([NaN, NaN; NaN, NaN]))
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4950
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4951 %!error NaN (3, 'like', int8 (1))
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4952
28930 2883b3d08b7e maint: Remove unnecessary parentheses bracketing %!error BIST tests. Rik <rik@octave.org> parents: 28919 diff changeset	4953 %!error NaN (3, "int8")
2883b3d08b7e maint: Remove unnecessary parentheses bracketing %!error BIST tests. Rik <rik@octave.org> parents: 28919 diff changeset	4954 %!error NaN (2, 3, "int8")
2883b3d08b7e maint: Remove unnecessary parentheses bracketing %!error BIST tests. Rik <rik@octave.org> parents: 28919 diff changeset	4955 %!error NaN (3, 2, "int8")
2883b3d08b7e maint: Remove unnecessary parentheses bracketing %!error BIST tests. Rik <rik@octave.org> parents: 28919 diff changeset	4956 %!error NaN (3, 4, 5, "int8")
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4957 %!error <input .* floating> NaN (3, 3, "like", true)
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	4958 %!error <input .* floating> NaN (2, "like", uint8 (1))
30934 d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4959 %!error <must be scalar> NaN (1:3, 1)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4960 %!error <must be scalar> NaN (1, 1:3)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4961 %!error <must be scalar> NaN (1, 2, 1:3)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	4962 %!error <must be scalar> NaN (1:3, 1, "like", single (1))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4963 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4964
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4965 DEFUN (e, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4966 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	4967 @deftypefn {} {@var{A} =} e
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	4968 @deftypefnx {} {@var{A} =} e (@var{n})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	4969 @deftypefnx {} {@var{A} =} e (@var{n}, @var{m})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	4970 @deftypefnx {} {@var{A} =} e (@var{n}, @var{m}, @var{k}, @dots{})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	4971 @deftypefnx {} {@var{A} =} e (@dots{}, @var{class})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4972 Return a scalar, matrix, or N-dimensional array whose elements are all equal
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4973 to the base of natural logarithms.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4974
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4975 The constant
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4976 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4977 $e$ satisfies the equation $\log (e) = 1$.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4978 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4979 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4980 @samp{e} satisfies the equation @code{log} (e) = 1.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4981 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4982
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4983 When called with no arguments, return a scalar with the value @math{e}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4984
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	4985 When called with a single argument, return a square matrix with the dimension
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	4986 specified.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4987
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4988 When called with more than one scalar argument the first two arguments are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4989 taken as the number of rows and columns and any further arguments specify
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4990 additional matrix dimensions.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4991
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	4992 The optional argument @var{class} specifies the return type and may be either
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	4993 @qcode{"double"} or @qcode{"single"}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4994 @seealso{log, exp, pi, I}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	4995 @end deftypefn */)
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4996 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4997 #if defined (M_E)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4998 double e_val = M_E;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4999 #else
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5000 double e_val = exp (1.0);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5001 #endif
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5002
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5003 return fill_matrix (args, e_val, "e");
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5004 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5005
24295 48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5006 template <typename T>
48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5007 T
48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5008 eps (const T& x)
48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5009 {
48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5010 T epsval = x.abs ();
48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5011 typedef typename T::value_type P;
48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5012 for (octave_idx_type i = 0; i < x.numel (); i++)
48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5013 {
48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5014 P val = epsval.xelem (i);
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	5015 if (math::isnan (val) \|\| math::isinf (val))
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	5016 epsval(i) = numeric_limits<P>::NaN ();
24295 48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5017 else if (val < std::numeric_limits<P>::min ())
48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5018 epsval(i) = std::numeric_limits<P>::denorm_min ();
48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5019 else
48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5020 {
48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5021 int exponent;
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	5022 math::frexp (val, &exponent);
24295 48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5023 const P digits = std::numeric_limits<P>::digits;
48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5024 epsval(i) = std::pow (static_cast<P> (2.0),
48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5025 static_cast<P> (exponent - digits));
48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5026 }
48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5027 }
48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5028 return epsval;
48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5029 }
48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5030
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5031 DEFUN (eps, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5032 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5033 @deftypefn {} {@var{d} =} eps
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5034 @deftypefnx {} {@var{d} =} eps (@var{x})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5035 @deftypefnx {} {@var{d} =} eps (@var{n}, @var{m})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5036 @deftypefnx {} {@var{d} =} eps (@var{n}, @var{m}, @var{k}, @dots{})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5037 @deftypefnx {} {@var{d} =} eps (@dots{}, @var{class})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5038 Return a scalar, matrix or N-dimensional array whose elements are all eps,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5039 the machine precision.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5040
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5041 More precisely, @code{eps} is the relative spacing between any two adjacent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5042 numbers in the machine's floating point system. This number is obviously
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5043 system dependent. On machines that support IEEE floating point arithmetic,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5044 @code{eps} is approximately
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5045 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5046 $2.2204\times10^{-16}$ for double precision and $1.1921\times10^{-7}$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5047 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5048 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5049 2.2204e-16 for double precision and 1.1921e-07
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5050 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5051 for single precision.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5052
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5053 When called with no arguments, return a scalar with the value
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5054 @code{eps (1.0)}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5055
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5056 Given a single argument @var{x}, return the distance between @var{x} and the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5057 next largest value.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5058
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5059 When called with more than one argument the first two arguments are taken as
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5060 the number of rows and columns and any further arguments specify additional
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5061 matrix dimensions. The optional argument @var{class} specifies the return
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5062 type and may be either @qcode{"double"} or @qcode{"single"}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5063 @seealso{realmax, realmin, intmax, flintmax}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5064 @end deftypefn */)
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5065 {
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	5066 octave_value retval;
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	5067
20819 f428cbe7576f eliminate unnecessary uses of nargin John W. Eaton <jwe@octave.org> parents: 20816 diff changeset	5068 if (args.length () == 1 && ! args(0).is_string ())
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	5069 {
24295 48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5070 octave_value arg0 = args(0);
23287 953cb077757c use magnitude when computing eps for complex values (bug #50553) John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	5071 if (arg0.is_single_type ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5072 {
24295 48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5073 FloatNDArray epsval = eps (arg0.float_array_value ());
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5074 retval = epsval;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5075 }
24296 3981e3a11150 eps: error if input is not of floating point type Carnë Draug <carandraug@octave.org> parents: 24295 diff changeset	5076 else if (arg0.is_double_type ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5077 {
24295 48e7efceb427 libinterp/corefcn/data.cc: template eps() to reduce code duplication Carnë Draug <carandraug@octave.org> parents: 24219 diff changeset	5078 NDArray epsval = eps (arg0.array_value ());
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5079 retval = epsval;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5080 }
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	5081 else
24296 3981e3a11150 eps: error if input is not of floating point type Carnë Draug <carandraug@octave.org> parents: 24295 diff changeset	5082 error ("eps: X must be of a floating point type");
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	5083 }
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	5084 else
15213 336f42406671 use numeric_limits functions instead of DBL_MIN, DBL_MAX, etc. John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	5085 retval = fill_matrix (args, std::numeric_limits<double>::epsilon (),
336f42406671 use numeric_limits functions instead of DBL_MIN, DBL_MAX, etc. John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	5086 std::numeric_limits<float>::epsilon (), "eps");
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	5087
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	5088 return retval;
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5089 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5090
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	5091 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5092 %!assert (eps (1/2), 2^(-53))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5093 %!assert (eps (1), 2^(-52))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5094 %!assert (eps (2), 2^(-51))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5095 %!assert (eps (realmax), 2^971)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5096 %!assert (eps (0), 2^(-1074))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5097 %!assert (eps (realmin/2), 2^(-1074))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5098 %!assert (eps (realmin/16), 2^(-1074))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5099 %!assert (eps (Inf), NaN)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5100 %!assert (eps (NaN), NaN)
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	5101 %!assert (eps ([1/2 1 2 realmax 0 realmin/2 realmin/16 Inf NaN]),
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	5102 %! [2^-53 2^-52 2^-51 2^971 2^-1074 2^-1074 2^-1074 NaN NaN])
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5103 %!assert (eps (single (1/2)), single (2^(-24)))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5104 %!assert (eps (single (1)), single (2^(-23)))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5105 %!assert (eps (single (2)), single (2^(-22)))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5106 %!assert (eps (realmax ("single")), single (2^104))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5107 %!assert (eps (single (0)), single (2^(-149)))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5108 %!assert (eps (realmin ("single")/2), single (2^(-149)))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5109 %!assert (eps (realmin ("single")/16), single (2^(-149)))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5110 %!assert (eps (single (Inf)), single (NaN))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5111 %!assert (eps (single (NaN)), single (NaN))
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	5112 %!assert (eps (single ([1/2 1 2 realmax("single") 0 realmin("single")/2 realmin("single")/16 Inf NaN])),
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	5113 %! single ([2^-24 2^-23 2^-22 2^104 2^-149 2^-149 2^-149 NaN NaN]))
32060 1203a2d81a42 Add BIST tests for Matlab compatibility for functions which accept negative dimensions. Rik <rik@octave.org> parents: 32046 diff changeset	5114
1203a2d81a42 Add BIST tests for Matlab compatibility for functions which accept negative dimensions. Rik <rik@octave.org> parents: 32046 diff changeset	5115 ## Note: Matlab compatibility requires using 0 for negative dimensions.
1203a2d81a42 Add BIST tests for Matlab compatibility for functions which accept negative dimensions. Rik <rik@octave.org> parents: 32046 diff changeset	5116 %!assert (size (eps (2, -3, 2)), [2, 0, 2])
1203a2d81a42 Add BIST tests for Matlab compatibility for functions which accept negative dimensions. Rik <rik@octave.org> parents: 32046 diff changeset	5117
24296 3981e3a11150 eps: error if input is not of floating point type Carnë Draug <carandraug@octave.org> parents: 24295 diff changeset	5118 %!error <X must be of a floating point type> eps (uint8 ([0 1 2]))
30934 d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	5119 %!error <must be scalar> eps (1:3, 1)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	5120 %!error <must be scalar> eps (1, 1:3)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	5121 %!error <must be scalar> eps (1, 2, 1:3)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	5122 %!error <must be scalar> eps (1:3, 1, "single")
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	5123 */
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	5124
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5125 DEFUN (pi, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5126 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5127 @deftypefn {} {@var{p} =} pi
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5128 @deftypefnx {} {@var{p} =} pi (@var{n})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5129 @deftypefnx {} {@var{p} =} pi (@var{n}, @var{m})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5130 @deftypefnx {} {@var{p} =} pi (@var{n}, @var{m}, @var{k}, @dots{})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5131 @deftypefnx {} {@var{p} =} pi (@dots{}, @var{class})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5132 Return a scalar, matrix, or N-dimensional array whose elements are all equal
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5133 to the ratio of the circumference of a circle to its
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5134 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5135 diameter($\pi$).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5136 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5137 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5138 diameter.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5139 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5140
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5141 When called with no arguments, return a scalar with the value of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5142 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5143 $\pi$.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5144 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5145 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5146 pi.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5147 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5148
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5149 When called with a single argument, return a square matrix with the dimension
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5150 specified.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5151
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5152 When called with more than one scalar argument the first two arguments are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5153 taken as the number of rows and columns and any further arguments specify
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5154 additional matrix dimensions.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5155
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5156 The optional argument @var{class} specifies the return type and may be either
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5157 @qcode{"double"} or @qcode{"single"}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5158 @seealso{e, I}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5159 @end deftypefn */)
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5160 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5161 #if defined (M_PI)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5162 double pi_val = M_PI;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5163 #else
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5164 double pi_val = 4.0 * atan (1.0);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5165 #endif
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5166
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5167 return fill_matrix (args, pi_val, "pi");
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5168 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5169
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5170 DEFUN (realmax, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5171 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5172 @deftypefn {} {@var{Rmax} =} realmax
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5173 @deftypefnx {} {@var{Rmax} =} realmax (@var{n})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5174 @deftypefnx {} {@var{Rmax} =} realmax (@var{n}, @var{m})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5175 @deftypefnx {} {@var{Rmax} =} realmax (@var{n}, @var{m}, @var{k}, @dots{})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5176 @deftypefnx {} {@var{Rmax} =} realmax (@dots{}, @var{class})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5177 Return a scalar, matrix, or N-dimensional array whose elements are all equal
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5178 to the largest floating point number that is representable.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5179
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5180 The actual value is system dependent. On machines that support IEEE
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5181 floating point arithmetic, @code{realmax} is approximately
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5182 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5183 $1.7977\times10^{308}$ for double precision and $3.4028\times10^{38}$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5184 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5185 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5186 1.7977e+308 for double precision and 3.4028e+38
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5187 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5188 for single precision.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5189
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5190 When called with no arguments, return a scalar with the value
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5191 @code{realmax (@qcode{"double"})}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5192
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5193 When called with a single argument, return a square matrix with the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5194 dimension specified.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5195
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5196 When called with more than one scalar argument the first two arguments are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5197 taken as the number of rows and columns and any further arguments specify
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5198 additional matrix dimensions.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5199
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5200 The optional argument @var{class} specifies the return type and may be
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5201 either @qcode{"double"} or @qcode{"single"}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5202 @seealso{realmin, intmax, flintmax, eps}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5203 @end deftypefn */)
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5204 {
15213 336f42406671 use numeric_limits functions instead of DBL_MIN, DBL_MAX, etc. John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	5205 return fill_matrix (args, std::numeric_limits<double>::max (),
336f42406671 use numeric_limits functions instead of DBL_MIN, DBL_MAX, etc. John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	5206 std::numeric_limits<float>::max (), "realmax");
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5207 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5208
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5209 DEFUN (realmin, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5210 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5211 @deftypefn {} {@var{Rmin} =} realmin
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5212 @deftypefnx {} {@var{Rmin} =} realmin (@var{n})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5213 @deftypefnx {} {@var{Rmin} =} realmin (@var{n}, @var{m})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5214 @deftypefnx {} {@var{Rmin} =} realmin (@var{n}, @var{m}, @var{k}, @dots{})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5215 @deftypefnx {} {@var{Rmin} =} realmin (@dots{}, @var{class})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5216 Return a scalar, matrix, or N-dimensional array whose elements are all equal
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5217 to the smallest normalized floating point number that is representable.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5218
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5219 The actual value is system dependent. On machines that support IEEE floating
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5220 point arithmetic, @code{realmin} is approximately
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5221 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5222 $2.2251\times10^{-308}$ for double precision and $1.1755\times10^{-38}$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5223 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5224 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5225 2.2251e-308 for double precision and 1.1755e-38
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5226 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5227 for single precision.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5228
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5229 When called with no arguments, return a scalar with the value
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5230 @code{realmin (@qcode{"double"})}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5231
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5232 When called with a single argument, return a square matrix with the dimension
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5233 specified.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5234
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5235 When called with more than one scalar argument the first two arguments are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5236 taken as the number of rows and columns and any further arguments specify
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5237 additional matrix dimensions.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5238
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5239 The optional argument @var{class} specifies the return type and may be either
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5240 @qcode{"double"} or @qcode{"single"}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5241 @seealso{realmax, intmin, eps}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5242 @end deftypefn */)
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5243 {
15213 336f42406671 use numeric_limits functions instead of DBL_MIN, DBL_MAX, etc. John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	5244 return fill_matrix (args, std::numeric_limits<double>::min (),
336f42406671 use numeric_limits functions instead of DBL_MIN, DBL_MAX, etc. John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	5245 std::numeric_limits<float>::min (), "realmin");
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5246 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5247
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5248 DEFUN (I, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5249 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5250 @c List other forms of function in documentation index
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5251 @findex i
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5252 @findex j
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5253 @findex J
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5254
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5255 @deftypefn {} {@var{A} =} I
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5256 @deftypefnx {} {@var{A} =} I (@var{n})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5257 @deftypefnx {} {@var{A} =} I (@var{n}, @var{m})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5258 @deftypefnx {} {@var{A} =} I (@var{n}, @var{m}, @var{k}, @dots{})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5259 @deftypefnx {} {@var{A} =} I (@dots{}, @var{class})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5260 Return a scalar, matrix, or N-dimensional array whose elements are all equal
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5261 to the pure imaginary unit, defined as
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5262 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5263 $\sqrt{-1}$.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5264 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5265 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5266 @w{@code{sqrt (-1)}}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5267 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5268
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5269 I, and its equivalents i, j, and J, are functions so any of the names may
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5270 be reused for other purposes (such as i for a counter variable).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5271
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5272 When called with no arguments, return a scalar with the value @math{i}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5273
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5274 When called with a single argument, return a square matrix with the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5275 dimension specified.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5276
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5277 When called with more than one scalar argument the first two arguments are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5278 taken as the number of rows and columns and any further arguments specify
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5279 additional matrix dimensions.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5280
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5281 The optional argument @var{class} specifies the return type and may be
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5282 either @qcode{"double"} or @qcode{"single"}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5283 @seealso{e, pi, log, exp}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5284 @end deftypefn */)
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5285 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5286 return fill_matrix (args, Complex (0.0, 1.0), "I");
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5287 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5288
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5289 DEFALIAS (i, I);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5290 DEFALIAS (J, I);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5291 DEFALIAS (j, I);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5292
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5293 DEFUN (NA, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5294 doc: /* -- texinfo --
29218 8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	5295 @deftypefn {} {@var{val} =} NA
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	5296 @deftypefnx {} {@var{val} =} NA (@var{n})
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	5297 @deftypefnx {} {@var{val} =} NA (@var{n}, @var{m})
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	5298 @deftypefnx {} {@var{val} =} NA (@var{n}, @var{m}, @var{k}, @dots{})
31611 535492e34f8f doc: Don't use TexInfo @var{} macro "like" for zeros, ones, etc. Rik <rik@octave.org> parents: 31607 diff changeset	5299 @deftypefnx {} {@var{val} =} NA (@dots{}, "like", @var{var})
29218 8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	5300 @deftypefnx {} {@var{val} =} NA (@dots{}, @var{class})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5301 Return a scalar, matrix, or N-dimensional array whose elements are all equal
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5302 to the special constant used to designate missing values.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5303
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5304 Note that NA always compares not equal to NA (NA != NA).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5305 To find NA values, use the @code{isna} function.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5306
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5307 When called with no arguments, return a scalar with the value @samp{NA}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5308
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5309 When called with a single argument, return a square matrix with the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5310 dimension specified.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5311
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5312 When called with more than one scalar argument the first two arguments are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5313 taken as the number of rows and columns and any further arguments specify
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5314 additional matrix dimensions.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5315
29218 8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	5316 If a variable @var{var} is specified after @qcode{"like"}, the output @var{val}
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	5317 will have the same data type, complexity, and sparsity as @var{var}.
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	5318
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5319 The optional argument @var{class} specifies the return type and may be
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5320 either @qcode{"double"} or @qcode{"single"}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5321 @seealso{isna}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5322 @end deftypefn */)
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5323 {
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	5324 return fill_matrix (args, lo_ieee_na_value (),
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5325 lo_ieee_float_na_value (), "NA");
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5326 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5327
7991 139f47cf17ab Change NA value to support single to double precision conversion David Bateman <dbateman@free.fr> parents: 7919 diff changeset	5328 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5329 %!assert (single (NA ("double")), NA ("single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5330 %!assert (double (NA ("single")), NA ("double"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5331 */
7991 139f47cf17ab Change NA value to support single to double precision conversion David Bateman <dbateman@free.fr> parents: 7919 diff changeset	5332
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5333 DEFUN (false, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5334 doc: /* -- texinfo --
29218 8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	5335 @deftypefn {} {@var{val} =} false (@var{x})
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	5336 @deftypefnx {} {@var{val} =} false (@var{n}, @var{m})
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	5337 @deftypefnx {} {@var{val} =} false (@var{n}, @var{m}, @var{k}, @dots{})
31611 535492e34f8f doc: Don't use TexInfo @var{} macro "like" for zeros, ones, etc. Rik <rik@octave.org> parents: 31607 diff changeset	5338 @deftypefnx {} {@var{val} =} false (@dots{}, "like", @var{var})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5339 Return a matrix or N-dimensional array whose elements are all logical 0.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5340
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5341 If invoked with a single scalar integer argument, return a square
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5342 matrix of the specified size.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5343
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5344 If invoked with two or more scalar integer arguments, or a vector of integer
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5345 values, return an array with given dimensions.
29218 8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	5346
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	5347 If a logical variable @var{var} is specified after @qcode{"like"}, the output
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	5348 @var{val} will have the same sparsity as @var{var}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5349 @seealso{true}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5350 @end deftypefn */)
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5351 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5352 return fill_matrix (args, false, "false");
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5353 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5354
28115 de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	5355 /*
de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	5356 %!assert (false (2, 3), logical (zeros (2, 3)))
de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	5357 %!assert (false (2, 3, "logical"), logical (zeros (2, 3)))
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	5358 %!assert (false (2, 1, "like", true), [false; false])
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	5359 %!assert (false (2, 1, "like", sparse (true)), sparse ([false; false]))
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	5360
28115 de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	5361 %!error false (2, 3, "double")
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	5362 %!error <input .* logical> false (2, 1, "like", sparse (1))
30934 d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	5363 %!error <must be scalar> false (1:3, 1)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	5364 %!error <must be scalar> false (1, 1:3)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	5365 %!error <must be scalar> false (1, 2, 1:3)
28115 de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	5366 */
de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	5367
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5368 DEFUN (true, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5369 doc: /* -- texinfo --
29218 8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	5370 @deftypefn {} {@var{val} =} true (@var{x})
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	5371 @deftypefnx {} {@var{val} =} true (@var{n}, @var{m})
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	5372 @deftypefnx {} {@var{val} =} true (@var{n}, @var{m}, @var{k}, @dots{})
31611 535492e34f8f doc: Don't use TexInfo @var{} macro "like" for zeros, ones, etc. Rik <rik@octave.org> parents: 31607 diff changeset	5373 @deftypefnx {} {@var{val} =} true (@dots{}, "like", @var{var})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5374 Return a matrix or N-dimensional array whose elements are all logical 1.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5375
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5376 If invoked with a single scalar integer argument, return a square
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5377 matrix of the specified size.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5378
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5379 If invoked with two or more scalar integer arguments, or a vector of integer
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5380 values, return an array with given dimensions.
29218 8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	5381
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	5382 If a logical variable @var{var} is specified after @qcode{"like"}, the output
8469b3aad7ac ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). Markus Mützel <markus.muetzel@gmx.de> parents: 29163 diff changeset	5383 @var{val} will have the same sparsity as @var{var}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5384 @seealso{false}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5385 @end deftypefn */)
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5386 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5387 return fill_matrix (args, true, "true");
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	5388 }
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5389
28115 de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	5390 /*
de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	5391 %!assert (true (2, 3), logical (ones (2, 3)))
de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	5392 %!assert (true (2, 3, "logical"), logical (ones (2, 3)))
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	5393 %!assert (true (2, 1, "like", false), [true; true])
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	5394 %!assert (true (2, 1, "like", sparse (true)), sparse ([true; true]))
d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	5395
28115 de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	5396 %!error true (2, 3, "double")
29086 d0fe364977c1 zeros, ones, NaN, Inf, NA: Add "like" syntax (bug #50865). Markus Mützel <markus.muetzel@gmx.de> parents: 28960 diff changeset	5397 %!error <input .* logical> true (2, 1, "like", double (1))
30934 d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	5398 %!error <must be scalar> true (1:3, 1)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	5399 %!error <must be scalar> true (1, 1:3)
d7f799e6d836 Check that dimensions input arguments for ones/zeros/... are scalar (bug #62291). Markus Mützel <markus.muetzel@gmx.de> parents: 30896 diff changeset	5400 %!error <must be scalar> true (1, 2, 1:3)
28115 de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	5401 */
de2c73ae450f allow data type argument for true and false functions John W. Eaton <jwe@octave.org> parents: 28043 diff changeset	5402
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21129 diff changeset	5403 template <typename MT>
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5404 octave_value
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5405 identity_matrix (int nr, int nc)
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5406 {
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5407 octave_value retval;
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5408
9685 e793865ede63 implement builtin_type Jaroslav Hajek <highegg@gmail.com> parents: 9658 diff changeset	5409 typename MT::element_type one (1);
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5410
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5411 if (nr == 1 && nc == 1)
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5412 retval = one;
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5413 else
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5414 {
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5415 dim_vector dims (nr, nc);
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5416
9685 e793865ede63 implement builtin_type Jaroslav Hajek <highegg@gmail.com> parents: 9658 diff changeset	5417 typename MT::element_type zero (0);
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5418
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5419 MT m (dims, zero);
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5420
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5421 if (nr > 0 && nc > 0)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5422 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5423 int n = std::min (nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5424
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5425 for (int i = 0; i < n; i++)
30390 a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30377 diff changeset	5426 m(i, i) = one;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5427 }
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5428
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5429 retval = m;
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5430 }
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5431
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5432 return retval;
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5433 }
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5434
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	5435 #define INSTANTIATE_EYE(T) \
5058 11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5436 template octave_value identity_matrix<T> (int, int)
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5437
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5438 INSTANTIATE_EYE (int8NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5439 INSTANTIATE_EYE (uint8NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5440 INSTANTIATE_EYE (int16NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5441 INSTANTIATE_EYE (uint16NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5442 INSTANTIATE_EYE (int32NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5443 INSTANTIATE_EYE (uint32NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5444 INSTANTIATE_EYE (int64NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5445 INSTANTIATE_EYE (uint64NDArray);
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	5446 INSTANTIATE_EYE (FloatNDArray);
5058 11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5447 INSTANTIATE_EYE (NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5448 INSTANTIATE_EYE (boolNDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5449
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5450 static octave_value
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	5451 identity_matrix (int nr, int nc, oct_data_conv::data_type dt)
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5452 {
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5453 octave_value retval;
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5454
25926 373fe1608f7c Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension (bug #54781). Rik <rik@octave.org> parents: 25917 diff changeset	5455 // FIXME: Perhaps this should be made extensible by using the class name
373fe1608f7c Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension (bug #54781). Rik <rik@octave.org> parents: 25917 diff changeset	5456 // to lookup a function to call to create the new value.
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5457
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5458 switch (dt)
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5459 {
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5460 case oct_data_conv::dt_int8:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5461 retval = identity_matrix<int8NDArray> (nr, nc);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5462 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5463
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5464 case oct_data_conv::dt_uint8:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5465 retval = identity_matrix<uint8NDArray> (nr, nc);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5466 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5467
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5468 case oct_data_conv::dt_int16:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5469 retval = identity_matrix<int16NDArray> (nr, nc);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5470 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5471
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5472 case oct_data_conv::dt_uint16:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5473 retval = identity_matrix<uint16NDArray> (nr, nc);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5474 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5475
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5476 case oct_data_conv::dt_int32:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5477 retval = identity_matrix<int32NDArray> (nr, nc);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5478 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5479
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5480 case oct_data_conv::dt_uint32:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5481 retval = identity_matrix<uint32NDArray> (nr, nc);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5482 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5483
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5484 case oct_data_conv::dt_int64:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5485 retval = identity_matrix<int64NDArray> (nr, nc);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5486 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5487
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5488 case oct_data_conv::dt_uint64:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5489 retval = identity_matrix<uint64NDArray> (nr, nc);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5490 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5491
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5492 case oct_data_conv::dt_single:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5493 retval = FloatDiagMatrix (nr, nc, 1.0f);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5494 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5495
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5496 case oct_data_conv::dt_double:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5497 retval = DiagMatrix (nr, nc, 1.0);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5498 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5499
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5500 case oct_data_conv::dt_logical:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5501 retval = identity_matrix<boolNDArray> (nr, nc);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5502 break;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5503
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5504 default:
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5505 error ("eye: invalid class name");
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5506 break;
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5507 }
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5508
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5509 return retval;
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5510 }
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5511
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5512 #undef INT_EYE_MATRIX
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5513
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	5514 DEFUN (eye, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5515 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5516 @deftypefn {} {@var{I} =} eye (@var{n})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5517 @deftypefnx {} {@var{I} =} eye (@var{m}, @var{n})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5518 @deftypefnx {} {@var{I} =} eye ([@var{m} @var{n}])
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5519 @deftypefnx {} {@var{I} =} eye (@dots{}, @var{class})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5520 Return an identity matrix.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5521
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5522 If invoked with a single scalar argument @var{n}, return a square
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5523 @nospell{NxN} identity matrix.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5524
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5525 If supplied two scalar arguments (@var{m}, @var{n}), @code{eye} takes them
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5526 to be the number of rows and columns. If given a vector with two elements,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5527 @code{eye} uses the values of the elements as the number of rows and
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5528 columns, respectively. For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5529
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5530 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5531 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5532 eye (3)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5533 @result{} 1 0 0
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5534 0 1 0
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5535 0 0 1
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5536 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5537 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5538
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5539 The following expressions all produce the same result:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5540
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5541 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5542 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5543 eye (2)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5544 @equiv{}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5545 eye (2, 2)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5546 @equiv{}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5547 eye (size ([1, 2; 3, 4]))
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5548 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5549 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5550
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5551 The optional argument @var{class}, allows @code{eye} to return an array of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5552 the specified type, like
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5553
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5554 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5555 val = zeros (n,m, "uint8")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5556 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5557
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5558 Calling @code{eye} with no arguments is equivalent to calling it with an
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5559 argument of 1. Any negative dimensions are treated as zero. These odd
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5560 definitions are for compatibility with @sc{matlab}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5561 @seealso{speye, ones, zeros}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5562 @end deftypefn */)
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5563 {
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	5564 int nargin = args.length ();
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5565
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	5566 oct_data_conv::data_type dt = oct_data_conv::dt_double;
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5567
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5568 // Check for type information.
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5569
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5570 if (nargin > 0 && args(nargin-1).is_string ())
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5571 {
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	5572 std::string nm = args(nargin-1).string_value ();
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5573 nargin--;
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	5574
7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	5575 dt = oct_data_conv::string_to_data_type (nm);
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5576 }
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5577
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5578 if (nargin > 2)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5579 print_usage ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5580
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	5581 octave_value retval;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	5582
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5583 if (nargin == 0)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5584 retval = identity_matrix (1, 1, dt);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5585 else if (nargin == 1)
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5586 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5587 octave_idx_type nr, nc;
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	5588 get_dimensions (args(0), "eye", nr, nc);
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5589
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5590 retval = identity_matrix (nr, nc, dt);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5591 }
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5592 else
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5593 {
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5594 octave_idx_type nr, nc;
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	5595 get_dimensions (args(0), args(1), "eye", nr, nc);
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5596
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5597 retval = identity_matrix (nr, nc, dt);
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5598 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5599
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5600 return retval;
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5601 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5602
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5603 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5604 %!assert (full (eye (3)), [1, 0, 0; 0, 1, 0; 0, 0, 1])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5605 %!assert (full (eye (2, 3)), [1, 0, 0; 0, 1, 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5606
32060 1203a2d81a42 Add BIST tests for Matlab compatibility for functions which accept negative dimensions. Rik <rik@octave.org> parents: 32046 diff changeset	5607 %!assert (full (eye (3, "single")), single ([1, 0, 0; 0, 1, 0; 0, 0, 1]))
1203a2d81a42 Add BIST tests for Matlab compatibility for functions which accept negative dimensions. Rik <rik@octave.org> parents: 32046 diff changeset	5608 %!assert (full (eye (2, 3, "single")), single ([1, 0, 0; 0, 1, 0]))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5609
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5610 %!assert (eye (3, "int8"), int8 ([1, 0, 0; 0, 1, 0; 0, 0, 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5611 %!assert (eye (2, 3, "int8"), int8 ([1, 0, 0; 0, 1, 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5612
32060 1203a2d81a42 Add BIST tests for Matlab compatibility for functions which accept negative dimensions. Rik <rik@octave.org> parents: 32046 diff changeset	5613 ## Note: Matlab compatibility requires using 0 for negative dimensions.
1203a2d81a42 Add BIST tests for Matlab compatibility for functions which accept negative dimensions. Rik <rik@octave.org> parents: 32046 diff changeset	5614 %!assert (size (eye (2, -3)), [2, 0])
1203a2d81a42 Add BIST tests for Matlab compatibility for functions which accept negative dimensions. Rik <rik@octave.org> parents: 32046 diff changeset	5615
25928 a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	5616 ## Test input validation
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5617 %!error eye (1, 2, 3)
25928 a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	5618 %!error <conversion of 1.1 .*failed> eye (1.1)
a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	5619 %!error <conversion of 1.1 .*failed> eye (1, 1.1)
a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	5620 %!error <conversion of 1.1 .*failed> eye ([1, 1.1])
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5621 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5622
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21129 diff changeset	5623 template <typename MT>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	5624 static octave_value
9658 3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5625 do_linspace (const octave_value& base, const octave_value& limit,
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5626 octave_idx_type n)
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5627 {
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5628 typedef typename MT::column_vector_type CVT;
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5629 typedef typename MT::element_type T;
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5630
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5631 octave_value retval;
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5632
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5633 if (base.is_scalar_type ())
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5634 {
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5635 T bs = octave_value_extract<T> (base);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5636 if (limit.is_scalar_type ())
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5637 {
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5638 T ls = octave_value_extract<T> (limit);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5639 retval = linspace (bs, ls, n);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5640 }
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5641 else
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5642 {
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5643 CVT lv = octave_value_extract<CVT> (limit);
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20218 diff changeset	5644 CVT bv (lv.numel (), bs);
9658 3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5645 retval = linspace (bv, lv, n);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5646 }
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5647 }
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5648 else
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5649 {
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5650 CVT bv = octave_value_extract<CVT> (base);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5651 if (limit.is_scalar_type ())
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5652 {
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5653 T ls = octave_value_extract<T> (limit);
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20218 diff changeset	5654 CVT lv (bv.numel (), ls);
9658 3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5655 retval = linspace (bv, lv, n);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5656 }
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5657 else
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5658 {
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5659 CVT lv = octave_value_extract<CVT> (limit);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5660 retval = linspace (bv, lv, n);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5661 }
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5662 }
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5663
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5664 return retval;
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5665 }
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5666
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	5667 DEFUN (linspace, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5668 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5669 @deftypefn {} {@var{y} =} linspace (@var{start}, @var{end})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5670 @deftypefnx {} {@var{y} =} linspace (@var{start}, @var{end}, @var{n})
24504 5188d936c79a doc: Documentation fixes for linspace, logspace, lookup (bug #52785). Rik <rik@octave.org> parents: 24440 diff changeset	5671 Return a row vector with @var{n} linearly spaced elements between @var{start}
5188d936c79a doc: Documentation fixes for linspace, logspace, lookup (bug #52785). Rik <rik@octave.org> parents: 24440 diff changeset	5672 and @var{end}.
5188d936c79a doc: Documentation fixes for linspace, logspace, lookup (bug #52785). Rik <rik@octave.org> parents: 24440 diff changeset	5673
31923 073cc98750c6 doc: Improve documentation for linspace and logspace functions. Rik <rik@octave.org> parents: 31706 diff changeset	5674 If the number of elements @var{n} is greater than one, then the endpoints
073cc98750c6 doc: Improve documentation for linspace and logspace functions. Rik <rik@octave.org> parents: 31706 diff changeset	5675 @var{start} and @var{end} are always included in the range. If @var{start} is
073cc98750c6 doc: Improve documentation for linspace and logspace functions. Rik <rik@octave.org> parents: 31706 diff changeset	5676 greater than @var{end}, the elements are stored in decreasing order. If the
073cc98750c6 doc: Improve documentation for linspace and logspace functions. Rik <rik@octave.org> parents: 31706 diff changeset	5677 number of points @var{n} is not specified, a value of 100 is used.
24504 5188d936c79a doc: Documentation fixes for linspace, logspace, lookup (bug #52785). Rik <rik@octave.org> parents: 24440 diff changeset	5678
5188d936c79a doc: Documentation fixes for linspace, logspace, lookup (bug #52785). Rik <rik@octave.org> parents: 24440 diff changeset	5679 The @code{linspace} function returns a row vector when both @var{start} and
5188d936c79a doc: Documentation fixes for linspace, logspace, lookup (bug #52785). Rik <rik@octave.org> parents: 24440 diff changeset	5680 @var{end} are scalars. If one, or both, inputs are vectors, then
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5681 @code{linspace} transforms them to column vectors and returns a matrix where
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5682 each row is an independent sequence between
24504 5188d936c79a doc: Documentation fixes for linspace, logspace, lookup (bug #52785). Rik <rik@octave.org> parents: 24440 diff changeset	5683 @w{@code{@var{start}(@var{row_n}), @var{end}(@var{row_n})}}.
5188d936c79a doc: Documentation fixes for linspace, logspace, lookup (bug #52785). Rik <rik@octave.org> parents: 24440 diff changeset	5684
31923 073cc98750c6 doc: Improve documentation for linspace and logspace functions. Rik <rik@octave.org> parents: 31706 diff changeset	5685 Programming Notes: For compatibility with @sc{matlab}, return the second
073cc98750c6 doc: Improve documentation for linspace and logspace functions. Rik <rik@octave.org> parents: 31706 diff changeset	5686 argument (@var{end}) when a single value (@var{n} = 1) is requested. If
073cc98750c6 doc: Improve documentation for linspace and logspace functions. Rik <rik@octave.org> parents: 31706 diff changeset	5687 @var{n} is not an integer then @code{floor (@var{n})} is used to round the
073cc98750c6 doc: Improve documentation for linspace and logspace functions. Rik <rik@octave.org> parents: 31706 diff changeset	5688 number of elements. If @var{n} is zero or negative then an empty 1x0 matrix
073cc98750c6 doc: Improve documentation for linspace and logspace functions. Rik <rik@octave.org> parents: 31706 diff changeset	5689 is returned.
24504 5188d936c79a doc: Documentation fixes for linspace, logspace, lookup (bug #52785). Rik <rik@octave.org> parents: 24440 diff changeset	5690 @seealso{colon, logspace}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5691 @end deftypefn */)
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5692 {
3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5693 int nargin = args.length ();
3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5694
1940 1b193e313c56 [project @ 1996-02-13 16:28:47 by jwe] jwe parents: 1884 diff changeset	5695 if (nargin != 2 && nargin != 3)
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5696 print_usage ();
1940 1b193e313c56 [project @ 1996-02-13 16:28:47 by jwe] jwe parents: 1884 diff changeset	5697
6133 e0065af38cf4 [project @ 2006-11-02 03:33:50 by jwe] jwe parents: 5991 diff changeset	5698 octave_idx_type npoints = 100;
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5699 if (nargin == 3)
16077 39129305b914 provide some undocumented matlab behavior for linspace (bug #38151) John W. Eaton <jwe@octave.org> parents: 15623 diff changeset	5700 {
39129305b914 provide some undocumented matlab behavior for linspace (bug #38151) John W. Eaton <jwe@octave.org> parents: 15623 diff changeset	5701 // Apparently undocumented Matlab. If the third arg is an empty
39129305b914 provide some undocumented matlab behavior for linspace (bug #38151) John W. Eaton <jwe@octave.org> parents: 15623 diff changeset	5702 // numeric value, the number of points defaults to 1.
39129305b914 provide some undocumented matlab behavior for linspace (bug #38151) John W. Eaton <jwe@octave.org> parents: 15623 diff changeset	5703 octave_value arg_3 = args(2);
39129305b914 provide some undocumented matlab behavior for linspace (bug #38151) John W. Eaton <jwe@octave.org> parents: 15623 diff changeset	5704
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23585 diff changeset	5705 if (arg_3.isnumeric () && arg_3.isempty ())
16077 39129305b914 provide some undocumented matlab behavior for linspace (bug #38151) John W. Eaton <jwe@octave.org> parents: 15623 diff changeset	5706 npoints = 1;
20466 16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20405 diff changeset	5707 else if (! arg_3.is_scalar_type ())
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20405 diff changeset	5708 error ("linspace: N must be a scalar");
16077 39129305b914 provide some undocumented matlab behavior for linspace (bug #38151) John W. Eaton <jwe@octave.org> parents: 15623 diff changeset	5709 else
20573 32a0bf9906c1 linspace: remove use of error_state. Carnë Draug <carandraug@octave.org> parents: 20562 diff changeset	5710 // Even if third arg is not an integer, it must be cast to int
16077 39129305b914 provide some undocumented matlab behavior for linspace (bug #38151) John W. Eaton <jwe@octave.org> parents: 15623 diff changeset	5711 npoints = arg_3.idx_type_value ();
39129305b914 provide some undocumented matlab behavior for linspace (bug #38151) John W. Eaton <jwe@octave.org> parents: 15623 diff changeset	5712 }
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5713
20573 32a0bf9906c1 linspace: remove use of error_state. Carnë Draug <carandraug@octave.org> parents: 20562 diff changeset	5714 octave_value arg_1 = args(0);
32a0bf9906c1 linspace: remove use of error_state. Carnë Draug <carandraug@octave.org> parents: 20562 diff changeset	5715 octave_value arg_2 = args(1);
32a0bf9906c1 linspace: remove use of error_state. Carnë Draug <carandraug@octave.org> parents: 20562 diff changeset	5716
32598 2f3b54f81947 avoid dim_vector copies in more places where possible (bug #64962) John W. Eaton <jwe@octave.org> parents: 32585 diff changeset	5717 const dim_vector& sz1 = arg_1.dims ();
21660 53728df3e4c9 maint: for clarity, call ndims() rather than length() on dimension vectors. Rik <rik@octave.org> parents: 21602 diff changeset	5718 bool isvector1 = sz1.ndims () == 2 && (sz1(0) == 1 \|\| sz1(1) == 1);
32598 2f3b54f81947 avoid dim_vector copies in more places where possible (bug #64962) John W. Eaton <jwe@octave.org> parents: 32585 diff changeset	5719 const dim_vector& sz2 = arg_2.dims ();
21660 53728df3e4c9 maint: for clarity, call ndims() rather than length() on dimension vectors. Rik <rik@octave.org> parents: 21602 diff changeset	5720 bool isvector2 = sz2.ndims () == 2 && (sz2(0) == 1 \|\| sz2(1) == 1);
20573 32a0bf9906c1 linspace: remove use of error_state. Carnë Draug <carandraug@octave.org> parents: 20562 diff changeset	5721
32a0bf9906c1 linspace: remove use of error_state. Carnë Draug <carandraug@octave.org> parents: 20562 diff changeset	5722 if (! isvector1 \|\| ! isvector2)
24535 22a2bc91cc7f Add more BIST tests for linspace. Rik <rik@octave.org> parents: 24534 diff changeset	5723 error ("linspace: START, END must be scalars or vectors");
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	5724
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	5725 octave_value retval;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	5726
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	5727 if (arg_1.is_single_type () \|\| arg_2.is_single_type ())
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5728 {
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	5729 if (arg_1.iscomplex () \|\| arg_2.iscomplex ())
20573 32a0bf9906c1 linspace: remove use of error_state. Carnë Draug <carandraug@octave.org> parents: 20562 diff changeset	5730 retval = do_linspace<FloatComplexMatrix> (arg_1, arg_2, npoints);
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5731 else
20573 32a0bf9906c1 linspace: remove use of error_state. Carnë Draug <carandraug@octave.org> parents: 20562 diff changeset	5732 retval = do_linspace<FloatMatrix> (arg_1, arg_2, npoints);
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5733 }
4732 b484cdca27be [project @ 2004-02-04 04:32:48 by jwe] jwe parents: 4685 diff changeset	5734 else
20573 32a0bf9906c1 linspace: remove use of error_state. Carnë Draug <carandraug@octave.org> parents: 20562 diff changeset	5735 {
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	5736 if (arg_1.iscomplex () \|\| arg_2.iscomplex ())
20573 32a0bf9906c1 linspace: remove use of error_state. Carnë Draug <carandraug@octave.org> parents: 20562 diff changeset	5737 retval = do_linspace<ComplexMatrix> (arg_1, arg_2, npoints);
32a0bf9906c1 linspace: remove use of error_state. Carnë Draug <carandraug@octave.org> parents: 20562 diff changeset	5738 else
32a0bf9906c1 linspace: remove use of error_state. Carnë Draug <carandraug@octave.org> parents: 20562 diff changeset	5739 retval = do_linspace<Matrix> (arg_1, arg_2, npoints);
32a0bf9906c1 linspace: remove use of error_state. Carnë Draug <carandraug@octave.org> parents: 20562 diff changeset	5740 }
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5741
3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5742 return retval;
3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5743 }
3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5744
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5745 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5746 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5747 %! x1 = linspace (1, 2);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5748 %! x2 = linspace (1, 2, 10);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5749 %! x3 = linspace (1, -2, 10);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5750 %! assert (size (x1) == [1, 100] && x1(1) == 1 && x1(100) == 2);
24536 bcaeb5439707 Fix typos and add tolerance to linspace BIST tests in 22a2bc91cc7f. Rik <rik@octave.org> parents: 24535 diff changeset	5751 %! assert (x1(2) - x1(1), (2 - 1)/ (100 - 1), eps);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5752 %! assert (size (x2) == [1, 10] && x2(1) == 1 && x2(10) == 2);
24536 bcaeb5439707 Fix typos and add tolerance to linspace BIST tests in 22a2bc91cc7f. Rik <rik@octave.org> parents: 24535 diff changeset	5753 %! assert (x2(2) - x2(1), (2 - 1)/ (10 - 1), eps);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5754 %! assert (size (x3) == [1, 10] && x3(1) == 1 && x3(10) == -2);
24543 0c204cd762a4 Fix reversal of START,END in linspace BIST test in cset 22a2bc91cc7f. Rik <rik@octave.org> parents: 24540 diff changeset	5755 %! assert (x3(2) - x3(1), (-2 - 1)/ (10 - 1), eps);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5756
20466 16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20405 diff changeset	5757 ## Test complex values
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20405 diff changeset	5758 %!test
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20405 diff changeset	5759 %! exp = [1+0i, 2-1.25i, 3-2.5i, 4-3.75i, 5-5i];
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20405 diff changeset	5760 %! obs = linspace (1, 5-5i, 5);
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20405 diff changeset	5761 %! assert (obs, exp);
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20405 diff changeset	5762
24535 22a2bc91cc7f Add more BIST tests for linspace. Rik <rik@octave.org> parents: 24534 diff changeset	5763 ## Test support for vectors in START and END
20574 780431fc4137 linspace: add tests for the use of vectors as base and limit. Carnë Draug <carandraug@octave.org> parents: 20573 diff changeset	5764 %!assert (linspace ([1 2 3], [7 8 9]),
22495 ad815427f376 Add 10eps tolerance for linspace tests to pass on Windows (bug #49092). Rik <rik@octave.org>* parents: 22489 diff changeset	5765 %! [linspace(1, 7); linspace(2, 8); linspace(3, 9)], 10*eps)
20574 780431fc4137 linspace: add tests for the use of vectors as base and limit. Carnë Draug <carandraug@octave.org> parents: 20573 diff changeset	5766 %!assert (linspace ([1 2 3]', [7 8 9]'),
22495 ad815427f376 Add 10eps tolerance for linspace tests to pass on Windows (bug #49092). Rik <rik@octave.org>* parents: 22489 diff changeset	5767 %! [linspace(1, 7); linspace(2, 8); linspace(3, 9)], 10*eps)
20574 780431fc4137 linspace: add tests for the use of vectors as base and limit. Carnë Draug <carandraug@octave.org> parents: 20573 diff changeset	5768 %!assert (linspace ([1 2 3], 9),
22495 ad815427f376 Add 10eps tolerance for linspace tests to pass on Windows (bug #49092). Rik <rik@octave.org>* parents: 22489 diff changeset	5769 %! [linspace(1, 9); linspace(2, 9); linspace(3, 9)], 10*eps)
20574 780431fc4137 linspace: add tests for the use of vectors as base and limit. Carnë Draug <carandraug@octave.org> parents: 20573 diff changeset	5770 %!assert (linspace ([1 2 3]', 9),
22495 ad815427f376 Add 10eps tolerance for linspace tests to pass on Windows (bug #49092). Rik <rik@octave.org>* parents: 22489 diff changeset	5771 %! [linspace(1, 9); linspace(2, 9); linspace(3, 9)], 10*eps)
20574 780431fc4137 linspace: add tests for the use of vectors as base and limit. Carnë Draug <carandraug@octave.org> parents: 20573 diff changeset	5772 %!assert (linspace (1, [7 8 9]),
22495 ad815427f376 Add 10eps tolerance for linspace tests to pass on Windows (bug #49092). Rik <rik@octave.org>* parents: 22489 diff changeset	5773 %! [linspace(1, 7); linspace(1, 8); linspace(1, 9)], 10*eps)
20574 780431fc4137 linspace: add tests for the use of vectors as base and limit. Carnë Draug <carandraug@octave.org> parents: 20573 diff changeset	5774 %!assert (linspace (1, [7 8 9]'),
22495 ad815427f376 Add 10eps tolerance for linspace tests to pass on Windows (bug #49092). Rik <rik@octave.org>* parents: 22489 diff changeset	5775 %! [linspace(1, 7); linspace(1, 8); linspace(1, 9)], 10*eps)
20574 780431fc4137 linspace: add tests for the use of vectors as base and limit. Carnë Draug <carandraug@octave.org> parents: 20573 diff changeset	5776
20466 16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20405 diff changeset	5777 ## Test class of output
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20405 diff changeset	5778 %!assert (class (linspace (1, 2)), "double")
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20405 diff changeset	5779 %!assert (class (linspace (single (1), 2)), "single")
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20405 diff changeset	5780 %!assert (class (linspace (1, single (2))), "single")
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20405 diff changeset	5781
27435 a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5782 ## Test symmetry
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5783 %!test <*56659>
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5784 %! x = linspace (-1, 1, 10);
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5785 %! assert (all (x == -fliplr (x)));
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5786 %! x = linspace (-1, 1, 11);
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5787 %! assert (all (x == -fliplr (x)));
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5788
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5789 %!test <*56659>
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5790 %! x = linspace (-1-1i, 1+1i, 10);
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5791 %! assert (all (x == -fliplr (x)));
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5792 %! x = linspace (-1-1i, 1+1i, 11);
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5793 %! assert (all (x == -fliplr (x)));
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5794
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5795 %!test <*56659>
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5796 %! x = linspace (single (-1), 1, 10);
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5797 %! assert (all (x == -fliplr (x)));
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5798 %! x = linspace (single (-1), 1, 11);
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5799 %! assert (all (x == -fliplr (x)));
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5800
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5801 %!test <*56659>
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5802 %! x = linspace (single (-1-1i), 1+1i, 10);
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5803 %! assert (all (x == -fliplr (x)));
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5804 %! x = linspace (single (-1-1i), 1+1i, 11);
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5805 %! assert (all (x == -fliplr (x)));
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5806
20466 16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20405 diff changeset	5807 ## Test obscure Matlab compatibility options
17206 ea5830dc6b19 test: Correct typo '%assert' -> '%!assert' to have test blocks run. Rik <rik@octave.org> parents: 17115 diff changeset	5808 %!assert (linspace (0, 1, []), 1)
20466 16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20405 diff changeset	5809 %!assert (linspace (10, 20, 2), [10 20])
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20405 diff changeset	5810 %!assert (linspace (10, 20, 1), [20])
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20405 diff changeset	5811 %!assert (linspace (10, 20, 0), zeros (1, 0))
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20405 diff changeset	5812 %!assert (linspace (10, 20, -1), zeros (1, 0))
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20405 diff changeset	5813 %!assert (numel (linspace (0, 1, 2+eps)), 2)
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20405 diff changeset	5814 %!assert (numel (linspace (0, 1, 2-eps)), 1)
20573 32a0bf9906c1 linspace: remove use of error_state. Carnë Draug <carandraug@octave.org> parents: 20562 diff changeset	5815 %!assert (linspace (10, 20, 2.1), [10 20])
32a0bf9906c1 linspace: remove use of error_state. Carnë Draug <carandraug@octave.org> parents: 20562 diff changeset	5816 %!assert (linspace (10, 20, 2.9), [10 20])
25237 ca022a8c4015 linspace: handle ranges with equal Inf endpoints (bug #53489) Maor Shutman <maorus12@gmail.com> parents: 25103 diff changeset	5817 %!assert (linspace (Inf, Inf, 3), [Inf, Inf, Inf])
ca022a8c4015 linspace: handle ranges with equal Inf endpoints (bug #53489) Maor Shutman <maorus12@gmail.com> parents: 25103 diff changeset	5818 %!assert (linspace (-Inf, -Inf, 3), [-Inf, -Inf, -Inf])
27435 a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5819 %!assert (linspace (-Inf, Inf, 3), [-Inf, 0, Inf])
31927 fef004fa8575 Improve Matlab compatibility of linspace for Inf endpoints. Rik <rik@octave.org> parents: 31924 diff changeset	5820 ## Octave prefers to return NaN which indicates failure of algorithm.
fef004fa8575 Improve Matlab compatibility of linspace for Inf endpoints. Rik <rik@octave.org> parents: 31924 diff changeset	5821 %!assert (linspace (-Inf, Inf, 4), [-Inf, NaN, NaN, Inf])
fef004fa8575 Improve Matlab compatibility of linspace for Inf endpoints. Rik <rik@octave.org> parents: 31924 diff changeset	5822 %!assert (linspace (-Inf, 0, 3), [-Inf, NaN, 0])
fef004fa8575 Improve Matlab compatibility of linspace for Inf endpoints. Rik <rik@octave.org> parents: 31924 diff changeset	5823 %!assert (linspace (-Inf, 0, 4), [-Inf, NaN, NaN, 0])
25237 ca022a8c4015 linspace: handle ranges with equal Inf endpoints (bug #53489) Maor Shutman <maorus12@gmail.com> parents: 25103 diff changeset	5824 %!assert (linspace (Inf + 1i, Inf + 1i, 3), [Inf + 1i, Inf + 1i, Inf + 1i])
31927 fef004fa8575 Improve Matlab compatibility of linspace for Inf endpoints. Rik <rik@octave.org> parents: 31924 diff changeset	5825 %!assert (linspace (-Inf - 1i, Inf + 1i, 3), [-Inf - 1i, 0 + 0i, Inf + 1i])
fef004fa8575 Improve Matlab compatibility of linspace for Inf endpoints. Rik <rik@octave.org> parents: 31924 diff changeset	5826 %!assert (linspace (-Inf - 1i, Inf + 2i, 3), [-Inf - 1i, NaN + 0.5i, Inf + 2i])
fef004fa8575 Improve Matlab compatibility of linspace for Inf endpoints. Rik <rik@octave.org> parents: 31924 diff changeset	5827 %!assert (linspace (-Inf - 3i, Inf + 0i, 4),
fef004fa8575 Improve Matlab compatibility of linspace for Inf endpoints. Rik <rik@octave.org> parents: 31924 diff changeset	5828 %! [-Inf - 3i, NaN - 2i, NaN - 1i, Inf + 0i])
fef004fa8575 Improve Matlab compatibility of linspace for Inf endpoints. Rik <rik@octave.org> parents: 31924 diff changeset	5829 %!assert (linspace (complex (-1, -Inf), complex (1, Inf), 3),
fef004fa8575 Improve Matlab compatibility of linspace for Inf endpoints. Rik <rik@octave.org> parents: 31924 diff changeset	5830 %! [complex(-1, -Inf), 0 + 0i, complex(1, Inf)])
fef004fa8575 Improve Matlab compatibility of linspace for Inf endpoints. Rik <rik@octave.org> parents: 31924 diff changeset	5831 %!assert (linspace (complex (-1, -Inf), complex (2, Inf), 3),
fef004fa8575 Improve Matlab compatibility of linspace for Inf endpoints. Rik <rik@octave.org> parents: 31924 diff changeset	5832 %! [complex(-1, -Inf), complex(0.5, NaN), complex(2, Inf)])
fef004fa8575 Improve Matlab compatibility of linspace for Inf endpoints. Rik <rik@octave.org> parents: 31924 diff changeset	5833 %!assert (linspace (complex (-3, -Inf), complex (0, Inf), 4),
fef004fa8575 Improve Matlab compatibility of linspace for Inf endpoints. Rik <rik@octave.org> parents: 31924 diff changeset	5834 %! [complex(-3, -Inf), complex(-2, NaN), complex(-1, NaN), complex(0, Inf)])
27435 a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5835
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5836 ## FIXME: Octave is not fully Matlab-compatible for some combinations of
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5837 ## Inf/-Inf endpoints. See bug #56933. This was dubbed "Won't Fix"
31927 fef004fa8575 Improve Matlab compatibility of linspace for Inf endpoints. Rik <rik@octave.org> parents: 31924 diff changeset	5838 ## as Octave prefers to return NaN for some of these conditions to
fef004fa8575 Improve Matlab compatibility of linspace for Inf endpoints. Rik <rik@octave.org> parents: 31924 diff changeset	5839 ## better reflect that the algorithm has failed. If the behavior in
fef004fa8575 Improve Matlab compatibility of linspace for Inf endpoints. Rik <rik@octave.org> parents: 31924 diff changeset	5840 ## the future is made compatible these tests can be re-instated.
27435 a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5841 ##%!assert <56933> (linspace (-Inf, Inf, 4), [-Inf, -Inf, Inf, Inf])
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5842 ##%!assert <56933> (linspace (-Inf, Inf, 5), [-Inf, -Inf, 0, Inf, Inf])
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5843 ##%!assert <56933> (linspace (0, Inf, 4), [0, Inf, Inf, Inf])
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5844 ##%!assert <56933> (linspace (0, -Inf, 4), [0, -Inf, -Inf, -Inf])
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5845 ##%!assert <56933> (linspace (-Inf, 0, 4), [-Inf, NaN, NaN, 0])
a8a5d2e8807f Produce symmetric sequences for linspace (bug #56659). Rik <rik@octave.org> parents: 27325 diff changeset	5846 ##%!assert <56933> (linspace (Inf, 0, 4), [Inf, NaN, NaN, 0])
31927 fef004fa8575 Improve Matlab compatibility of linspace for Inf endpoints. Rik <rik@octave.org> parents: 31924 diff changeset	5847 ##%!assert (1 ./ linspace (-0, 0, 4), [-Inf, Inf, Inf, Inf])
fef004fa8575 Improve Matlab compatibility of linspace for Inf endpoints. Rik <rik@octave.org> parents: 31924 diff changeset	5848
fef004fa8575 Improve Matlab compatibility of linspace for Inf endpoints. Rik <rik@octave.org> parents: 31924 diff changeset	5849 ## Test input validation
fef004fa8575 Improve Matlab compatibility of linspace for Inf endpoints. Rik <rik@octave.org> parents: 31924 diff changeset	5850 %!error <Invalid call> linspace ()
fef004fa8575 Improve Matlab compatibility of linspace for Inf endpoints. Rik <rik@octave.org> parents: 31924 diff changeset	5851 %!error <Invalid call> linspace (1, 2, 3, 4)
20466 16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20405 diff changeset	5852 %!error <N must be a scalar> linspace (1, 2, [3, 4])
24535 22a2bc91cc7f Add more BIST tests for linspace. Rik <rik@octave.org> parents: 24534 diff changeset	5853 %!error <START, END must be scalars or vectors> linspace (ones (2,2), 2, 3)
22a2bc91cc7f Add more BIST tests for linspace. Rik <rik@octave.org> parents: 24534 diff changeset	5854 %!error <START, END must be scalars or vectors> linspace (2, ones (2,2), 3)
22a2bc91cc7f Add more BIST tests for linspace. Rik <rik@octave.org> parents: 24534 diff changeset	5855 %!error <START, END must be scalars or vectors> linspace (1, [], 3)
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5856 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5857
20726 25d676f9619c Preface error() messages with name of function when possible. Rik <rik@octave.org> parents: 20720 diff changeset	5858 // FIXME: should accept dimensions as separate args for N-D
25d676f9619c Preface error() messages with name of function when possible. Rik <rik@octave.org> parents: 20720 diff changeset	5859 // arrays as well as 1-D and 2-D arrays.
5734 a7d2c47371d2 [project @ 2006-04-04 18:29:13 by jwe] jwe parents: 5731 diff changeset	5860
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5861 DEFUN (resize, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5862 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5863 @deftypefn {} {@var{B} =} resize (@var{A}, @var{m})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5864 @deftypefnx {} {@var{B} =} resize (@var{A}, @var{m}, @var{n}, @dots{})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5865 @deftypefnx {} {@var{B} =} resize (@var{A}, [@var{m} @var{n} @dots{}])
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5866 Resize @var{A} cutting off elements as necessary.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5867
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5868 In the result, element with certain indices is equal to the corresponding
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5869 element of @var{A} if the indices are within the bounds of @var{A}; otherwise,
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5870 the element is set to zero.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5871
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5872 In other words, the statement
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5873
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5874 @example
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5875 B = resize (A, dv)
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5876 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5877
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5878 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5879 is equivalent to the following code:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5880
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5881 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5882 @group
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5883 B = zeros (dv, class (A));
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5884 sz = min (dv, size (A));
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5885 for i = 1:length (sz)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5886 idx@{i@} = 1:sz(i);
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5887 endfor
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5888 B(idx@{:@}) = A(idx@{:@});
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5889 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5890 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5891
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5892 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5893 but is performed more efficiently.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5894
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5895 If only @var{m} is supplied, and it is a scalar, the dimension of the result is
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5896 @var{m}-by-@var{m}. If @var{m}, @var{n}, @dots{} are all scalars, then the
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5897 dimensions of the result are @var{m}-by-@var{n}-by-@dots{}. If given a vector
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5898 as input, then the dimensions of the result are given by the elements of that
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5899 vector.
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5900
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5901 An object can be resized to more dimensions than it has; in such case the
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5902 missing dimensions are assumed to be 1. Resizing an object to fewer dimensions
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5903 is not possible.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5904 @seealso{reshape, postpad, prepad, cat}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5905 @end deftypefn */)
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5906 {
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5907 int nargin = args.length ();
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5908
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5909 if (nargin < 2)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5910 print_usage ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5911
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5912 octave_value retval;
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5913
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5914 if (nargin == 2)
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5915 {
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5916 Array<double> vec = args(1).vector_value ();
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20218 diff changeset	5917 int ndim = vec.numel ();
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5918 if (ndim == 1)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5919 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5920 octave_idx_type m = static_cast<octave_idx_type> (vec(0));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5921 retval = args(0);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5922 retval = retval.resize (dim_vector (m, m), true);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5923 }
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5924 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5925 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5926 dim_vector dv;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5927 dv.resize (ndim);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5928 for (int i = 0; i < ndim; i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5929 dv(i) = static_cast<octave_idx_type> (vec(i));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5930 retval = args(0);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5931 retval = retval.resize (dv, true);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5932 }
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5933 }
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5934 else
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5935 {
8799 f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5936 dim_vector dv;
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5937 dv.resize (nargin - 1);
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5938 for (octave_idx_type i = 1; i < nargin; i++)
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5939 dv(i-1) = static_cast<octave_idx_type> (args(i).scalar_value ());
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5940
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5941 retval = args(0);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5942 retval = retval.resize (dv, true);
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5943 }
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	5944
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5945 return retval;
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5946 }
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5947
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	5948 // FIXME: should use octave_idx_type for dimensions.
5734 a7d2c47371d2 [project @ 2006-04-04 18:29:13 by jwe] jwe parents: 5731 diff changeset	5949
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5950 DEFUN (reshape, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5951 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5952 @deftypefn {} {@var{B} =} reshape (@var{A}, @var{m}, @var{n}, @dots{})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5953 @deftypefnx {} {@var{B} =} reshape (@var{A}, [@var{m} @var{n} @dots{}])
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5954 @deftypefnx {} {@var{B} =} reshape (@var{A}, @dots{}, [], @dots{})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	5955 @deftypefnx {} {@var{B} =} reshape (@var{A}, @var{size})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5956 Return a matrix with the specified dimensions (@var{m}, @var{n}, @dots{})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5957 whose elements are taken from the matrix @var{A}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5958
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5959 The elements of the matrix are accessed in column-major order (like Fortran
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5960 arrays are stored).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5961
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5962 The following code demonstrates reshaping a 1x4 row vector into a 2x2 square
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5963 matrix.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5964
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5965 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5966 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5967 reshape ([1, 2, 3, 4], 2, 2)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5968 @result{} 1 3
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5969 2 4
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5970 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5971 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5972
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5973 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5974 Note that the total number of elements in the original matrix
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5975 (@code{prod (size (@var{A}))}) must match the total number of elements
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5976 in the new matrix (@code{prod ([@var{m} @var{n} @dots{}])}).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5977
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5978 A single dimension of the return matrix may be left unspecified and Octave
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5979 will determine its size automatically. An empty matrix ([]) is used to flag
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5980 the unspecified dimension.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5981 @seealso{resize, vec, postpad, cat, squeeze}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	5982 @end deftypefn */)
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5983 {
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5984 int nargin = args.length ();
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5985
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5986 if (nargin < 2)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5987 print_usage ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	5988
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5989 octave_value retval;
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5990
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5991 dim_vector new_dims;
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5992
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5993 if (nargin == 2)
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5994 {
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5995 Array<octave_idx_type> new_size = args(1).octave_idx_type_vector_value ();
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5996
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20218 diff changeset	5997 if (new_size.numel () < 2)
20893 384ff5aa9437 2015 Code Sprint: Eliminate useless return statements after error (). Rik <rik@octave.org> parents: 20884 diff changeset	5998 error ("reshape: SIZE must have 2 or more dimensions");
17915 56d2b6838405 Issue an error if reshape called with just a single dimension. Rik <rik@octave.org> parents: 17843 diff changeset	5999
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20218 diff changeset	6000 new_dims = dim_vector::alloc (new_size.numel ());
a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20218 diff changeset	6001
a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20218 diff changeset	6002 for (octave_idx_type i = 0; i < new_size.numel (); i++)
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	6003 {
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	6004 if (new_size(i) < 0)
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6005 error ("reshape: SIZE must be non-negative");
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	6006
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	6007 new_dims(i) = new_size(i);
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	6008 }
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	6009 }
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6010 else
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	6011 {
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	6012 new_dims = dim_vector::alloc (nargin-1);
5013 1eb9ce5c0152 [project @ 2004-09-21 22:18:07 by jwe] jwe parents: 4986 diff changeset	6013 int empty_dim = -1;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	6014
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	6015 for (int i = 1; i < nargin; i++)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6016 {
23577 80c42f4cca13 maint: Deprecate is_empty and replace with isempty. Rik <rik@octave.org> parents: 23576 diff changeset	6017 if (args(i).isempty ())
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	6018 {
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	6019 if (empty_dim > 0)
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6020 error ("reshape: only a single dimension can be unknown");
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	6021
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	6022 empty_dim = i;
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	6023 new_dims(i-1) = 1;
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	6024 }
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6025 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6026 {
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	6027 new_dims(i-1) = args(i).idx_type_value ();
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6028
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	6029 if (new_dims(i-1) < 0)
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6030 error ("reshape: SIZE must be non-negative");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6031 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6032 }
5013 1eb9ce5c0152 [project @ 2004-09-21 22:18:07 by jwe] jwe parents: 4986 diff changeset	6033
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	6034 if (empty_dim > 0)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6035 {
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	6036 octave_idx_type nel = new_dims.numel ();
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6037
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6038 if (nel == 0)
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	6039 new_dims(empty_dim-1) = 0;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6040 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6041 {
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	6042 octave_idx_type a_nel = args(0).numel ();
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	6043 octave_idx_type size_empty_dim = a_nel / nel;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	6044
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	6045 if (a_nel != size_empty_dim * nel)
26164 7f6a50f73625 Silence compiler warnings about format identifier for octave_idx_type (bug #55046). Markus Mützel <markus.muetzel@gmx.de> parents: 26107 diff changeset	6046 error ("reshape: SIZE is not divisible by the product of "
7f6a50f73625 Silence compiler warnings about format identifier for octave_idx_type (bug #55046). Markus Mützel <markus.muetzel@gmx.de> parents: 26107 diff changeset	6047 "known dimensions (= %" OCTAVE_IDX_TYPE_FORMAT ")",
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6048 nel);
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	6049
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	6050 new_dims(empty_dim-1) = size_empty_dim;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6051 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6052 }
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	6053 }
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	6054
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	6055 retval = args(0).reshape (new_dims);
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	6056
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	6057 return retval;
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	6058 }
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	6059
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6060 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6061 %!assert (size (reshape (ones (4, 4), 2, 8)), [2, 8])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6062 %!assert (size (reshape (ones (4, 4), 8, 2)), [8, 2])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6063 %!assert (size (reshape (ones (15, 4), 1, 60)), [1, 60])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6064 %!assert (size (reshape (ones (15, 4), 60, 1)), [60, 1])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6065
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6066 %!assert (size (reshape (ones (4, 4, "single"), 2, 8)), [2, 8])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6067 %!assert (size (reshape (ones (4, 4, "single"), 8, 2)), [8, 2])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6068 %!assert (size (reshape (ones (15, 4, "single"), 1, 60)), [1, 60])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6069 %!assert (size (reshape (ones (15, 4, "single"), 60, 1)), [60, 1])
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6070
32045 f18da620ab4d Fix floating point exception when Sparse array reshaped to 0x0 (bug #64080) Rik <rik@octave.org> parents: 31923 diff changeset	6071 %!assert <*64080> (size (reshape (sparse (0, 1), 0, 0)), [0, 0])
f18da620ab4d Fix floating point exception when Sparse array reshaped to 0x0 (bug #64080) Rik <rik@octave.org> parents: 31923 diff changeset	6072
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6073 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6074 %! s.a = 1;
17915 56d2b6838405 Issue an error if reshape called with just a single dimension. Rik <rik@octave.org> parents: 17843 diff changeset	6075 %! fail ("reshape (s, 2, 3)", "can't reshape 1x1 array to 2x3 array");
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6076
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6077 %!error reshape ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6078 %!error reshape (1, 2, 3, 4)
17915 56d2b6838405 Issue an error if reshape called with just a single dimension. Rik <rik@octave.org> parents: 17843 diff changeset	6079 %!error <SIZE must have 2 or more dimensions> reshape (1:3, 3)
56d2b6838405 Issue an error if reshape called with just a single dimension. Rik <rik@octave.org> parents: 17843 diff changeset	6080 %!error <SIZE must be non-negative> reshape (1:3, [3 -1])
56d2b6838405 Issue an error if reshape called with just a single dimension. Rik <rik@octave.org> parents: 17843 diff changeset	6081 %!error <only a single dimension can be unknown> reshape (1:3, 1,[],[],3)
56d2b6838405 Issue an error if reshape called with just a single dimension. Rik <rik@octave.org> parents: 17843 diff changeset	6082 %!error <SIZE must be non-negative> reshape (1:3, 3, -1)
56d2b6838405 Issue an error if reshape called with just a single dimension. Rik <rik@octave.org> parents: 17843 diff changeset	6083 %!error <SIZE is not divisible> reshape (1:3, 3, [], 2)
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6084 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6085
10694 d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	6086 DEFUN (vec, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6087 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6088 @deftypefn {} {@var{v} =} vec (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6089 @deftypefnx {} {@var{v} =} vec (@var{x}, @var{dim})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6090 Return the vector obtained by stacking the columns of the matrix @var{x}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6091 one above the other.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6092
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6093 Without @var{dim} this is equivalent to @code{@var{x}(:)}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6094
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6095 If @var{dim} is supplied, the dimensions of @var{v} are set to @var{dim}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6096 with all elements along the last dimension. This is equivalent to
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6097 @code{shiftdim (@var{x}(:), 1-@var{dim})}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6098 @seealso{vech, resize, cat}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6099 @end deftypefn */)
10694 d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	6100 {
11402 a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	6101 int nargin = args.length ();
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	6102
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	6103 if (nargin < 1 \|\| nargin > 2)
21602 47c76e56a1de maint: Remove extra space between end of statement and semicolon. Rik <rik@octave.org> parents: 21580 diff changeset	6104 print_usage ();
11402 a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	6105
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6106 int dim = 1;
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	6107 if (nargin == 2)
11402 a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	6108 {
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	6109 dim = args(1).idx_type_value ();
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	6110
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	6111 if (dim < 1)
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	6112 error ("vec: DIM must be greater than zero");
11402 a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	6113 }
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	6114
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	6115 octave_value colon (octave_value::magic_colon_t);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	6116 octave_value arg = args(0);
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6117
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6118 octave_value retval = arg.single_subsref ("(", colon);
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	6119
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	6120 if (dim > 1)
10694 d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	6121 {
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	6122 dim_vector new_dims = dim_vector::alloc (dim);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	6123
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	6124 for (int i = 0; i < dim-1; i++)
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	6125 new_dims(i) = 1;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	6126
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	6127 new_dims(dim-1) = retval.numel ();
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	6128
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	6129 retval = retval.reshape (new_dims);
10694 d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	6130 }
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	6131
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	6132 return retval;
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	6133 }
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	6134
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	6135 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6136 %!assert (vec ([1, 2; 3, 4]), [1; 3; 2; 4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6137 %!assert (vec ([1, 3, 2, 4]), [1; 3; 2; 4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6138 %!assert (vec ([1, 2, 3, 4], 2), [1, 2, 3, 4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6139 %!assert (vec ([1, 2; 3, 4]), vec ([1, 2; 3, 4], 1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6140 %!assert (vec ([1, 2; 3, 4], 1), [1; 3; 2; 4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6141 %!assert (vec ([1, 2; 3, 4], 2), [1, 3, 2, 4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6142 %!assert (vec ([1, 3; 2, 4], 3), reshape ([1, 2, 3, 4], 1, 1, 4))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6143 %!assert (vec ([1, 3; 2, 4], 3), shiftdim (vec ([1, 3; 2, 4]), -2))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6144
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6145 %!error vec ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6146 %!error vec (1, 2, 3)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6147 %!error vec ([1, 2; 3, 4], 0)
10694 d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	6148 */
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	6149
4532 01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	6150 DEFUN (squeeze, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6151 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6152 @deftypefn {} {@var{B} =} squeeze (@var{A})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6153 Remove singleton dimensions from @var{A} and return the result.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6154
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6155 Note that for compatibility with @sc{matlab}, all objects have
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6156 a minimum of two dimensions and row vectors are left unchanged.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6157 @seealso{reshape}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6158 @end deftypefn */)
4532 01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	6159 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6160 if (args.length () != 1)
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	6161 print_usage ();
4532 01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	6162
21127 df7891224709 maint: Use "return ovl (...)" in DEFUN macros. Rik <rik@octave.org> parents: 21121 diff changeset	6163 return ovl (args(0).squeeze ());
4532 01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	6164 }
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	6165
8458 d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	6166 DEFUN (full, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6167 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6168 @deftypefn {} {@var{FM} =} full (@var{SM})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6169 Return a full storage matrix from a sparse, diagonal, or permutation matrix,
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6170 or from a range.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6171 @seealso{sparse, issparse}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6172 @end deftypefn */)
8458 d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	6173 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6174 if (args.length () != 1)
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	6175 print_usage ();
8458 d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	6176
21127 df7891224709 maint: Use "return ovl (...)" in DEFUN macros. Rik <rik@octave.org> parents: 21121 diff changeset	6177 return ovl (args(0).full_value ());
8458 d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	6178 }
d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	6179
6945 6bbf56a9718a [project @ 2007-10-02 20:47:22 by jwe] jwe parents: 6887 diff changeset	6180 // Compute various norms of the vector X.
6bbf56a9718a [project @ 2007-10-02 20:47:22 by jwe] jwe parents: 6887 diff changeset	6181
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	6182 DEFUN (norm, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6183 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6184 @deftypefn {} {@var{n} =} norm (@var{A})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6185 @deftypefnx {} {@var{n} =} norm (@var{A}, @var{p})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6186 @deftypefnx {} {@var{n} =} norm (@var{A}, @var{p}, @var{opt})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6187 Compute the p-norm of the matrix @var{A}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6188
22827 c3d3a81ad986 doc: Update documentation for norm, normest, normest1, condest. Rik <rik@octave.org> parents: 22791 diff changeset	6189 If the second argument is not given, @w{@code{p = 2}} is used.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6190
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6191 If @var{A} is a matrix (or sparse matrix):
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6192
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6193 @table @asis
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6194 @item @var{p} = @code{1}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6195 1-norm, the largest column sum of the absolute values of @var{A}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6196
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6197 @item @var{p} = @code{2}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6198 Largest singular value of @var{A}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6199
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6200 @item @var{p} = @code{Inf} or @qcode{"inf"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6201 @cindex infinity norm
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6202 Infinity norm, the largest row sum of the absolute values of @var{A}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6203
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6204 @item @var{p} = @qcode{"fro"}
25003 2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release. Rik <rik@octave.org> parents: 24859 diff changeset	6205 @cindex @nospell{Frobenius} norm
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release. Rik <rik@octave.org> parents: 24859 diff changeset	6206 @nospell{Frobenius} norm of @var{A},
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release. Rik <rik@octave.org> parents: 24859 diff changeset	6207 @code{sqrt (sum (diag (@var{A}' * @var{A})))}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6208
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6209 @item other @var{p}, @code{@var{p} > 1}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6210 @cindex general p-norm
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6211 maximum @code{norm (A*x, p)} such that @code{norm (x, p) == 1}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6212 @end table
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6213
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6214 If @var{A} is a vector or a scalar:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6215
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6216 @table @asis
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6217 @item @var{p} = @code{Inf} or @qcode{"inf"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6218 @code{max (abs (@var{A}))}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6219
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6220 @item @var{p} = @code{-Inf}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6221 @code{min (abs (@var{A}))}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6222
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6223 @item @var{p} = @qcode{"fro"}
25003 2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release. Rik <rik@octave.org> parents: 24859 diff changeset	6224 @nospell{Frobenius} norm of @var{A}, @code{sqrt (sumsq (abs (A)))}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6225
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6226 @item @var{p} = 0
22827 c3d3a81ad986 doc: Update documentation for norm, normest, normest1, condest. Rik <rik@octave.org> parents: 22791 diff changeset	6227 Hamming norm---the number of nonzero elements.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6228
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6229 @item other @var{p}, @code{@var{p} > 1}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6230 p-norm of @var{A}, @code{(sum (abs (@var{A}) .^ @var{p})) ^ (1/@var{p})}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6231
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6232 @item other @var{p} @code{@var{p} < 1}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6233 the p-pseudonorm defined as above.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6234 @end table
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6235
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6236 If @var{opt} is the value @qcode{"rows"}, treat each row as a vector and
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6237 compute its norm. The result is returned as a column vector.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6238 Similarly, if @var{opt} is @qcode{"columns"} or @qcode{"cols"} then
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6239 compute the norms of each column and return a row vector.
24219 3d96400df713 Add function vecnorm (bug #52342). Marco Caliari <marco.caliari@univr.it> parents: 24088 diff changeset	6240 @seealso{normest, normest1, vecnorm, cond, svd}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6241 @end deftypefn */)
6508 184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	6242 {
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	6243 int nargin = args.length ();
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	6244
22789 bedfedcd878e norm: fix error in input argument validation leading to segfault (bug #49634) Mike Miller <mtmiller@octave.org> parents: 22749 diff changeset	6245 if (nargin < 1 \|\| nargin > 3)
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6246 print_usage ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6247
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6248 octave_value x_arg = args(0);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6249
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6250 if (x_arg.ndims () != 2)
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6251 error ("norm: only valid for 2-D objects");
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6252
23147 eb5a162c1342 Accept case-insensitive string value for p-value input to norm (bug #50195); Rik <rik@octave.org> parents: 23141 diff changeset	6253 enum {sfmatrix, sfcols, sfrows, sffrob, sfinf, sfneginf} strflag = sfmatrix;
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6254 if (nargin > 1 && args(nargin-1).is_string ())
6508 184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	6255 {
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6256 std::string str = args(nargin-1).string_value ();
23147 eb5a162c1342 Accept case-insensitive string value for p-value input to norm (bug #50195); Rik <rik@octave.org> parents: 23141 diff changeset	6257 std::transform (str.begin (), str.end (), str.begin (), tolower);
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6258 if (str == "cols" \|\| str == "columns")
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6259 strflag = sfcols;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6260 else if (str == "rows")
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6261 strflag = sfrows;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6262 else if (str == "fro")
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6263 strflag = sffrob;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6264 else if (str == "inf")
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6265 strflag = sfinf;
23147 eb5a162c1342 Accept case-insensitive string value for p-value input to norm (bug #50195); Rik <rik@octave.org> parents: 23141 diff changeset	6266 else if (str == "-inf")
eb5a162c1342 Accept case-insensitive string value for p-value input to norm (bug #50195); Rik <rik@octave.org> parents: 23141 diff changeset	6267 strflag = sfneginf;
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6268 else
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6269 error ("norm: unrecognized option: %s", str.c_str ());
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	6270
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6271 // we've handled the last parameter, so act as if it was removed
21062 d9c1884d1aaa maint: Eliminate space between variable and decrement '--' operator. Rik <rik@octave.org> parents: 21055 diff changeset	6272 nargin--;
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6273 }
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6274
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6275 octave_value p_arg = (nargin > 1) ? args(1) : octave_value (2);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6276
23577 80c42f4cca13 maint: Deprecate is_empty and replace with isempty. Rik <rik@octave.org> parents: 23576 diff changeset	6277 if (p_arg.isempty ())
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6278 p_arg = octave_value (2);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6279 else if (p_arg.is_string ())
6508 184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	6280 {
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6281 std::string str = p_arg.string_value ();
23147 eb5a162c1342 Accept case-insensitive string value for p-value input to norm (bug #50195); Rik <rik@octave.org> parents: 23141 diff changeset	6282 std::transform (str.begin (), str.end (), str.begin (), tolower);
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	6283 if (strflag != sfcols && strflag != sfrows)
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	6284 error ("norm: invalid combination of options");
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	6285
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	6286 if (str == "cols" \|\| str == "columns" \|\| str == "rows")
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	6287 error ("norm: invalid combination of options");
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	6288
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	6289 if (str == "fro")
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	6290 p_arg = octave_value (2);
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	6291 else if (str == "inf")
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	6292 p_arg = numeric_limits<double>::Inf ();
23147 eb5a162c1342 Accept case-insensitive string value for p-value input to norm (bug #50195); Rik <rik@octave.org> parents: 23141 diff changeset	6293 else if (str == "-inf")
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	6294 p_arg = -numeric_limits<double>::Inf ();
6508 184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	6295 else
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	6296 error ("norm: unrecognized option: %s", str.c_str ());
6508 184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	6297 }
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6298 else if (! p_arg.is_scalar_type ())
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21078 diff changeset	6299 err_wrong_type_arg ("norm", p_arg);
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6300
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6301 octave_value retval;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6302
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6303 switch (strflag)
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6304 {
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6305 case sfmatrix:
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6306 retval = xnorm (x_arg, p_arg);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6307 break;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6308
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6309 case sfcols:
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6310 retval = xcolnorms (x_arg, p_arg);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6311 break;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6312
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6313 case sfrows:
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6314 retval = xrownorms (x_arg, p_arg);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6315 break;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6316
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6317 case sffrob:
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6318 retval = xfrobnorm (x_arg);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6319 break;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6320
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6321 case sfinf:
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	6322 retval = xnorm (x_arg, numeric_limits<double>::Inf ());
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6323 break;
23147 eb5a162c1342 Accept case-insensitive string value for p-value input to norm (bug #50195); Rik <rik@octave.org> parents: 23141 diff changeset	6324
eb5a162c1342 Accept case-insensitive string value for p-value input to norm (bug #50195); Rik <rik@octave.org> parents: 23141 diff changeset	6325 case sfneginf:
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	6326 retval = xnorm (x_arg, -numeric_limits<double>::Inf ());
23147 eb5a162c1342 Accept case-insensitive string value for p-value input to norm (bug #50195); Rik <rik@octave.org> parents: 23141 diff changeset	6327 break;
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6328 }
6508 184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	6329
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	6330 return retval;
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	6331 }
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	6332
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6333 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6334 %!shared x
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6335 %! x = [1, -3, 4, 5, -7];
23141 bfa4ad642fa0 Disallow p-norm of -Inf for matrices (bug #50194). Rik <rik@octave.org> parents: 23127 diff changeset	6336 %!assert (norm (x,0), 5)
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6337 %!assert (norm (x,1), 20)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6338 %!assert (norm (x,2), 10)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6339 %!assert (norm (x,3), 8.24257059961711, -4*eps)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6340 %!assert (norm (x,Inf), 7)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6341 %!assert (norm (x,-Inf), 1)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6342 %!assert (norm (x,"inf"), 7)
23147 eb5a162c1342 Accept case-insensitive string value for p-value input to norm (bug #50195); Rik <rik@octave.org> parents: 23141 diff changeset	6343 %!assert (norm (x,"-Inf"), 1)
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6344 %!assert (norm (x,"fro"), 10, -eps)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6345 %!assert (norm (x), 10)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6346 %!assert (norm ([1e200, 1]), 1e200)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6347 %!assert (norm ([3+4i, 3-4i, sqrt(31)]), 9, -4*eps)
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6348 %!shared m
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6349 %! m = magic (4);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6350 %!assert (norm (m,1), 34)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6351 %!assert (norm (m,2), 34, -eps)
23141 bfa4ad642fa0 Disallow p-norm of -Inf for matrices (bug #50194). Rik <rik@octave.org> parents: 23127 diff changeset	6352 %!assert (norm (m,3), 34, -sqrt (eps))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6353 %!assert (norm (m,Inf), 34)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6354 %!assert (norm (m,"inf"), 34)
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6355 %!shared m2, flo, fhi
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6356 %! m2 = [1,2;3,4];
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6357 %! flo = 1e-300;
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6358 %! fhi = 1e+300;
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6359 %!assert (norm (flom2,"fro"), sqrt (30)flo, -eps)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6360 %!assert (norm (fhim2,"fro"), sqrt (30)fhi, -eps)
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6361
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6362 %!shared x
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6363 %! x = single ([1, -3, 4, 5, -7]);
23141 bfa4ad642fa0 Disallow p-norm of -Inf for matrices (bug #50194). Rik <rik@octave.org> parents: 23127 diff changeset	6364 %!assert (norm (x,0), single (5))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6365 %!assert (norm (x,1), single (20))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6366 %!assert (norm (x,2), single (10))
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	6367 %!assert (norm (x,3), single (8.24257059961711), -4* eps ("single"))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6368 %!assert (norm (x,Inf), single (7))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6369 %!assert (norm (x,-Inf), single (1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6370 %!assert (norm (x,"inf"), single (7))
23147 eb5a162c1342 Accept case-insensitive string value for p-value input to norm (bug #50195); Rik <rik@octave.org> parents: 23141 diff changeset	6371 %!assert (norm (x,"-Inf"), single (1))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6372 %!assert (norm (x,"fro"), single (10), -eps ("single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6373 %!assert (norm (x), single (10))
18676 5bd1ca29c5f0 Clean up questionable code bits identified by clang sanitize. Rik <rik@octave.org> parents: 18212 diff changeset	6374 %!assert (norm (single ([1e38, 1])), single (1e38))
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	6375 %!assert (norm (single ([3+4i, 3-4i, sqrt(31)])), single (9), -4* eps ("single"))
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6376 %!shared m
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6377 %! m = single (magic (4));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6378 %!assert (norm (m,1), single (34))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6379 %!assert (norm (m,2), single (34), -eps ("single"))
23141 bfa4ad642fa0 Disallow p-norm of -Inf for matrices (bug #50194). Rik <rik@octave.org> parents: 23127 diff changeset	6380 %!assert (norm (m,3), single (34), -sqrt (eps ("single")))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6381 %!assert (norm (m,Inf), single (34))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6382 %!assert (norm (m,"inf"), single (34))
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6383 %!shared m2, flo, fhi
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6384 %! m2 = single ([1,2;3,4]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6385 %! flo = single (1e-300);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6386 %! fhi = single (1e+300);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6387 %!assert (norm (flom2,"fro"), single (sqrt (30)flo), -eps ("single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6388 %!assert (norm (fhim2,"fro"), single (sqrt (30)fhi), -eps ("single"))
14520 c4ed0fdf2b62 Fix initialization in Higham's method for norm estimate (bug #36031). Marco Caliari <marco.caliari@univr.it> parents: 14491 diff changeset	6389
23141 bfa4ad642fa0 Disallow p-norm of -Inf for matrices (bug #50194). Rik <rik@octave.org> parents: 23127 diff changeset	6390 ## Hamming norm (p == 0)
bfa4ad642fa0 Disallow p-norm of -Inf for matrices (bug #50194). Rik <rik@octave.org> parents: 23127 diff changeset	6391 %!assert (norm ([1, 0, 0, 0, 1], 0), 2)
bfa4ad642fa0 Disallow p-norm of -Inf for matrices (bug #50194). Rik <rik@octave.org> parents: 23127 diff changeset	6392
17115 00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	6393 %!shared q
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	6394 %! q = rand (1e3, 3);
21317 a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions. Rik <rik@octave.org> parents: 21301 diff changeset	6395 %!assert (norm (q, 3, "rows"), sum (q.^3, 2).^(1/3), sqrt (eps))
a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions. Rik <rik@octave.org> parents: 21301 diff changeset	6396 %!assert (norm (q, "fro", "rows"), sum (q.^2, 2).^(1/2), sqrt (eps))
a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions. Rik <rik@octave.org> parents: 21301 diff changeset	6397 %!assert (norm (q, "fro", "rows"), sqrt (sumsq (q, 2)), sqrt (eps))
a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions. Rik <rik@octave.org> parents: 21301 diff changeset	6398 %!assert (norm (q, "fro", "cols"), sqrt (sumsq (q, 1)), sqrt (eps))
a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions. Rik <rik@octave.org> parents: 21301 diff changeset	6399 %!assert (norm (q, 3, "cols"), sum (q.^3, 1).^(1/3), sqrt (eps))
a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions. Rik <rik@octave.org> parents: 21301 diff changeset	6400 %!assert (norm (q, "inf", "rows"), norm (q, Inf, "rows"))
a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions. Rik <rik@octave.org> parents: 21301 diff changeset	6401 %!assert (norm (q, "inf", "cols"), norm (q, Inf, "cols"))
a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions. Rik <rik@octave.org> parents: 21301 diff changeset	6402 %!assert (norm (q, [], "rows"), norm (q, 2, "rows"))
a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions. Rik <rik@octave.org> parents: 21301 diff changeset	6403 %!assert (norm (q, [], "cols"), norm (q, 2, "cols"))
17115 00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	6404
22489 93ea313301f9 test: Add bug ids (<#####>) to BIST tests. Rik <rik@octave.org> parents: 22440 diff changeset	6405 %!test <30631>
93ea313301f9 test: Add bug ids (<#####>) to BIST tests. Rik <rik@octave.org> parents: 22440 diff changeset	6406 %! ## Test for norm returning NaN on sparse matrix
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6407 %! A = sparse (2,2);
14520 c4ed0fdf2b62 Fix initialization in Higham's method for norm estimate (bug #36031). Marco Caliari <marco.caliari@univr.it> parents: 14491 diff changeset	6408 %! A(2,1) = 1;
c4ed0fdf2b62 Fix initialization in Higham's method for norm estimate (bug #36031). Marco Caliari <marco.caliari@univr.it> parents: 14491 diff changeset	6409 %! assert (norm (A), 1);
22789 bedfedcd878e norm: fix error in input argument validation leading to segfault (bug #49634) Mike Miller <mtmiller@octave.org> parents: 22749 diff changeset	6410
bedfedcd878e norm: fix error in input argument validation leading to segfault (bug #49634) Mike Miller <mtmiller@octave.org> parents: 22749 diff changeset	6411 ## Test input validation
bedfedcd878e norm: fix error in input argument validation leading to segfault (bug #49634) Mike Miller <mtmiller@octave.org> parents: 22749 diff changeset	6412 %!error norm ()
bedfedcd878e norm: fix error in input argument validation leading to segfault (bug #49634) Mike Miller <mtmiller@octave.org> parents: 22749 diff changeset	6413 %!error norm (1,2,3,4)
bedfedcd878e norm: fix error in input argument validation leading to segfault (bug #49634) Mike Miller <mtmiller@octave.org> parents: 22749 diff changeset	6414 %!error <unrecognized option> norm (1, "invalid")
bedfedcd878e norm: fix error in input argument validation leading to segfault (bug #49634) Mike Miller <mtmiller@octave.org> parents: 22749 diff changeset	6415 %!error <unrecognized option> norm (1, "rows", "invalid")
22791 da106618264a norm: fix input validation tests Mike Miller <mtmiller@octave.org> parents: 22789 diff changeset	6416 %!error <unrecognized option> norm (1, "invalid", "rows")
da106618264a norm: fix input validation tests Mike Miller <mtmiller@octave.org> parents: 22789 diff changeset	6417 %!error <invalid combination of options> norm (1, "cols", "rows")
22789 bedfedcd878e norm: fix error in input argument validation leading to segfault (bug #49634) Mike Miller <mtmiller@octave.org> parents: 22749 diff changeset	6418 %!error <invalid combination of options> norm (1, "rows", "rows")
23141 bfa4ad642fa0 Disallow p-norm of -Inf for matrices (bug #50194). Rik <rik@octave.org> parents: 23127 diff changeset	6419 %!error <p must be .= 1> norm (ones (2,2), -Inf)
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6420 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6421
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6422 static octave_value
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6423 unary_op_defun_body (octave_value::unary_op op,
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6424 const octave_value_list& args)
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6425 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6426 if (args.length () != 1)
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6427 print_usage ();
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6428
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	6429 return unary_op (op, args(0));
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6430 }
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6431
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6432 DEFUN (not, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6433 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6434 @deftypefn {} {@var{z} =} not (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6435 Return the logical NOT of @var{x}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6436
24618 c99163d188df doc: Use @var{} around variables in operator functions such as and, or, uplus. Rik <rik@octave.org> parents: 24517 diff changeset	6437 This function is equivalent to the operator syntax @w{@code{! @var{x}}}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6438 @seealso{and, or, xor}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6439 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6440 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6441 return unary_op_defun_body (octave_value::op_not, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6442 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6443
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6444 DEFUN (uplus, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6445 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6446 @deftypefn {} {@var{B} =} uplus (@var{A})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6447 This function and @w{@tcode{+ @var{A}}} are equivalent.
29514 ec768b0f7dcd doc: Use Texinfo commands to improve transpose() docstring rendering. Rik <rik@octave.org> parents: 29358 diff changeset	6448 @seealso{uminus, plus}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6449 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6450 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6451 return unary_op_defun_body (octave_value::op_uplus, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6452 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6453
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6454 DEFUN (uminus, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6455 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6456 @deftypefn {} {@var{B} =} uminus (@var{A})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6457 This function and @w{@tcode{- @var{A}}} are equivalent.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6458 @seealso{uplus, minus}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6459 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6460 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6461 return unary_op_defun_body (octave_value::op_uminus, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6462 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6463
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6464 DEFUN (transpose, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6465 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6466 @deftypefn {} {@var{B} =} transpose (@var{A})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6467 Return the transpose of @var{A}.
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6468
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6469 This function and @tcode{@var{A}.'@:} are equivalent.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6470 @seealso{ctranspose}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6471 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6472 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6473 return unary_op_defun_body (octave_value::op_transpose, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6474 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6475
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6476 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6477 %!assert (2.', 2)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6478 %!assert (2i.', 2i)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6479 %!assert ([1:4].', [1;2;3;4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6480 %!assert ([1;2;3;4].', [1:4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6481 %!assert ([1,2;3,4].', [1,3;2,4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6482 %!assert ([1,2i;3,4].', [1,3;2i,4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6483
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6484 %!assert (transpose ([1,2;3,4]), [1,3;2,4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6485
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6486 %!assert (single (2).', single (2))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6487 %!assert (single (2i).', single (2i))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6488 %!assert (single ([1:4]).', single ([1;2;3;4]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6489 %!assert (single ([1;2;3;4]).', single ([1:4]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6490 %!assert (single ([1,2;3,4]).', single ([1,3;2,4]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6491 %!assert (single ([1,2i;3,4]).', single ([1,3;2i,4]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6492
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6493 %!assert (transpose (single ([1,2;3,4])), single ([1,3;2,4]))
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6494 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6495
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6496 DEFUN (ctranspose, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6497 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6498 @deftypefn {} {@var{B} =} ctranspose (@var{A})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6499 Return the complex conjugate transpose of @var{A}.
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6500
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6501 This function and @tcode{@var{A}'} are equivalent.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6502 @seealso{transpose}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6503 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6504 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6505 return unary_op_defun_body (octave_value::op_hermitian, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6506 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6507
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6508 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6509 %!assert (2', 2)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6510 %!assert (2i', -2i)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6511 %!assert ([1:4]', [1;2;3;4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6512 %!assert ([1;2;3;4]', [1:4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6513 %!assert ([1,2;3,4]', [1,3;2,4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6514 %!assert ([1,2i;3,4]', [1,3;-2i,4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6515
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6516 %!assert (ctranspose ([1,2i;3,4]), [1,3;-2i,4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6517
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6518 %!assert (single (2)', single (2))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6519 %!assert (single (2i)', single (-2i))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6520 %!assert (single ([1:4])', single ([1;2;3;4]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6521 %!assert (single ([1;2;3;4])', single ([1:4]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6522 %!assert (single ([1,2;3,4])', single ([1,3;2,4]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6523 %!assert (single ([1,2i;3,4])', single ([1,3;-2i,4]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6524
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6525 %!assert (ctranspose (single ([1,2i;3,4])), single ([1,3;-2i,4]))
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6526 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6527
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6528 static octave_value
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6529 binary_op_defun_body (octave_value::binary_op op,
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6530 const octave_value_list& args)
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6531 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6532 if (args.length () != 2)
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6533 print_usage ();
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6534
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	6535 return binary_op (op, args(0), args(1));
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6536 }
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6537
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6538 static octave_value
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6539 binary_assoc_op_defun_body (octave_value::binary_op op,
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6540 octave_value::assign_op aop,
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6541 const octave_value_list& args)
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6542 {
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6543 int nargin = args.length ();
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6544
25267 308a272bbe3c Emit an error if binary operator functions (or, plus, etc.) are called with 1 arg (bug 53450). Rik <rik@octave.org> parents: 25237 diff changeset	6545 if (nargin < 2)
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6546 print_usage ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6547
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6548 octave_value retval;
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6549
25267 308a272bbe3c Emit an error if binary operator functions (or, plus, etc.) are called with 1 arg (bug 53450). Rik <rik@octave.org> parents: 25237 diff changeset	6550 if (nargin == 2)
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	6551 retval = binary_op (op, args(0), args(1));
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6552 else
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6553 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	6554 retval = binary_op (op, args(0), args(1));
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6555
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6556 for (int i = 2; i < nargin; i++)
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6557 retval.assign (aop, args(i));
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6558 }
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6559
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6560 return retval;
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6561 }
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	6562
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6563 DEFUN (plus, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6564 doc: /* -- texinfo --
31141 9e9f5f1e8ec2 doc: Update plus() function to use inputs A, B. Rik <rik@octave.org> parents: 31105 diff changeset	6565 @deftypefn {} {@var{C} =} plus (@var{A}, @var{B})
9e9f5f1e8ec2 doc: Update plus() function to use inputs A, B. Rik <rik@octave.org> parents: 31105 diff changeset	6566 @deftypefnx {} {@var{C} =} plus (@var{A1}, @var{A2}, @dots{})
9e9f5f1e8ec2 doc: Update plus() function to use inputs A, B. Rik <rik@octave.org> parents: 31105 diff changeset	6567 This function and @w{@tcode{@var{A} + @var{B}}} are equivalent.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6568
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6569 If more arguments are given, the summation is applied
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6570 cumulatively from left to right:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6571
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6572 @example
31141 9e9f5f1e8ec2 doc: Update plus() function to use inputs A, B. Rik <rik@octave.org> parents: 31105 diff changeset	6573 (@dots{}((@var{A1} + @var{A2}) + @var{A3}) + @dots{})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6574 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6575
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6576 @seealso{minus, uplus}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6577 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6578 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6579 return binary_assoc_op_defun_body (octave_value::op_add,
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6580 octave_value::op_add_eq, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6581 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6582
25267 308a272bbe3c Emit an error if binary operator functions (or, plus, etc.) are called with 1 arg (bug 53450). Rik <rik@octave.org> parents: 25237 diff changeset	6583 /*
308a272bbe3c Emit an error if binary operator functions (or, plus, etc.) are called with 1 arg (bug 53450). Rik <rik@octave.org> parents: 25237 diff changeset	6584 %!assert (plus (1,1), 2)
308a272bbe3c Emit an error if binary operator functions (or, plus, etc.) are called with 1 arg (bug 53450). Rik <rik@octave.org> parents: 25237 diff changeset	6585 %!assert (plus (1:3, 1), 2:4)
308a272bbe3c Emit an error if binary operator functions (or, plus, etc.) are called with 1 arg (bug 53450). Rik <rik@octave.org> parents: 25237 diff changeset	6586 %!assert (plus (1:3, 1, 3), 5:7)
308a272bbe3c Emit an error if binary operator functions (or, plus, etc.) are called with 1 arg (bug 53450). Rik <rik@octave.org> parents: 25237 diff changeset	6587 %!assert (plus (1,2,3,4,5,6,7,8,9), sum (1:9))
308a272bbe3c Emit an error if binary operator functions (or, plus, etc.) are called with 1 arg (bug 53450). Rik <rik@octave.org> parents: 25237 diff changeset	6588
308a272bbe3c Emit an error if binary operator functions (or, plus, etc.) are called with 1 arg (bug 53450). Rik <rik@octave.org> parents: 25237 diff changeset	6589 ## Test input validation for all functions which use binary_assoc_op_defun_body
308a272bbe3c Emit an error if binary operator functions (or, plus, etc.) are called with 1 arg (bug 53450). Rik <rik@octave.org> parents: 25237 diff changeset	6590 %!error plus ()
308a272bbe3c Emit an error if binary operator functions (or, plus, etc.) are called with 1 arg (bug 53450). Rik <rik@octave.org> parents: 25237 diff changeset	6591 %!error plus (1)
308a272bbe3c Emit an error if binary operator functions (or, plus, etc.) are called with 1 arg (bug 53450). Rik <rik@octave.org> parents: 25237 diff changeset	6592 */
308a272bbe3c Emit an error if binary operator functions (or, plus, etc.) are called with 1 arg (bug 53450). Rik <rik@octave.org> parents: 25237 diff changeset	6593
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6594 DEFUN (minus, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6595 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6596 @deftypefn {} {@var{C} =} minus (@var{A}, @var{B})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6597 This function and @w{@tcode{@var{A} - @var{B}}} are equivalent.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6598 @seealso{plus, uminus}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6599 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6600 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6601 return binary_op_defun_body (octave_value::op_sub, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6602 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6603
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6604 DEFUN (mtimes, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6605 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6606 @deftypefn {} {@var{C} =} mtimes (@var{A}, @var{B})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6607 @deftypefnx {} {@var{C} =} mtimes (@var{A1}, @var{A2}, @dots{})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6608 Return the matrix multiplication product of inputs.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6609
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6610 This function and @w{@tcode{@var{A} * @var{B}}} are equivalent.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6611 If more arguments are given, the multiplication is applied
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6612 cumulatively from left to right:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6613
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6614 @example
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6615 (@dots{}((@var{A1} * @var{A2}) * @var{A3}) * @dots{})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6616 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6617
31547 212cc32100f5 Add new function 'tensorprod' (patch #10288) Kasper H. Filtenborg <kasper.filtenborg@gmail.com> parents: 31375 diff changeset	6618 @seealso{times, plus, minus, rdivide, mrdivide, mldivide, mpower, tensorprod}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6619 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6620 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6621 return binary_assoc_op_defun_body (octave_value::op_mul,
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6622 octave_value::op_mul_eq, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6623 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6624
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6625 DEFUN (mrdivide, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6626 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6627 @deftypefn {} {@var{C} =} mrdivide (@var{A}, @var{B})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6628 Return the matrix right division of @var{A} and @var{B}.
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6629
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6630 This function and @w{@tcode{@var{A} / @var{B}}} are equivalent.
29825 290eff7148bb mrdivide, mldivide: Document that functions might return minimum norm solutions (bug #60839). Markus Mützel <markus.muetzel@gmx.de> parents: 29817 diff changeset	6631
290eff7148bb mrdivide, mldivide: Document that functions might return minimum norm solutions (bug #60839). Markus Mützel <markus.muetzel@gmx.de> parents: 29817 diff changeset	6632 If the system is not square, or if the coefficient matrix is singular, a
290eff7148bb mrdivide, mldivide: Document that functions might return minimum norm solutions (bug #60839). Markus Mützel <markus.muetzel@gmx.de> parents: 29817 diff changeset	6633 minimum norm solution is computed.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6634 @seealso{mldivide, rdivide, plus, minus}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6635 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6636 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6637 return binary_op_defun_body (octave_value::op_div, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6638 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6639
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6640 DEFUN (mpower, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6641 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6642 @deftypefn {} {@var{C} =} mpower (@var{A}, @var{B})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6643 Return the matrix power operation of @var{A} raised to the @var{B} power.
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6644
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6645 This function and @w{@tcode{@var{A} ^ @var{B}}} are equivalent.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6646 @seealso{power, mtimes, plus, minus}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6647 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6648 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6649 return binary_op_defun_body (octave_value::op_pow, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6650 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6651
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6652 DEFUN (mldivide, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6653 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6654 @deftypefn {} {@var{C} =} mldivide (@var{A}, @var{B})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6655 Return the matrix left division of @var{A} and @var{B}.
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6656
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6657 This function and @w{@tcode{@var{A} @backslashchar{} @var{B}}} are equivalent.
29825 290eff7148bb mrdivide, mldivide: Document that functions might return minimum norm solutions (bug #60839). Markus Mützel <markus.muetzel@gmx.de> parents: 29817 diff changeset	6658
290eff7148bb mrdivide, mldivide: Document that functions might return minimum norm solutions (bug #60839). Markus Mützel <markus.muetzel@gmx.de> parents: 29817 diff changeset	6659 If the system is not square, or if the coefficient matrix is singular, a
290eff7148bb mrdivide, mldivide: Document that functions might return minimum norm solutions (bug #60839). Markus Mützel <markus.muetzel@gmx.de> parents: 29817 diff changeset	6660 minimum norm solution is computed.
290eff7148bb mrdivide, mldivide: Document that functions might return minimum norm solutions (bug #60839). Markus Mützel <markus.muetzel@gmx.de> parents: 29817 diff changeset	6661 @seealso{mrdivide, ldivide, rdivide, linsolve}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6662 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6663 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6664 return binary_op_defun_body (octave_value::op_ldiv, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6665 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6666
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6667 DEFUN (lt, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6668 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6669 @deftypefn {} {@var{TF} =} lt (@var{A}, @var{B})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6670 This function is equivalent to @w{@code{@var{A} < @var{B}}}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6671 @seealso{le, eq, ge, gt, ne}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6672 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6673 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6674 return binary_op_defun_body (octave_value::op_lt, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6675 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6676
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6677 DEFUN (le, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6678 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6679 @deftypefn {} {@var{TF} =} le (@var{A}, @var{B})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6680 This function is equivalent to @w{@code{@var{A} <= @var{B}}}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6681 @seealso{eq, ge, gt, ne, lt}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6682 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6683 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6684 return binary_op_defun_body (octave_value::op_le, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6685 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6686
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6687 DEFUN (eq, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6688 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6689 @deftypefn {} {@var{TF} =} eq (@var{A}, @var{B})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6690 Return true if the two inputs are equal.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6691
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6692 This function is equivalent to @w{@code{@var{A} == @var{B}}}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6693 @seealso{ne, isequal, le, ge, gt, ne, lt}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6694 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6695 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6696 return binary_op_defun_body (octave_value::op_eq, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6697 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6698
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6699 DEFUN (ge, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6700 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6701 @deftypefn {} {@var{TF} =} ge (@var{A}, @var{B})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6702 This function is equivalent to @w{@code{@var{A} >= @var{B}}}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6703 @seealso{le, eq, gt, ne, lt}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6704 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6705 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6706 return binary_op_defun_body (octave_value::op_ge, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6707 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6708
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6709 DEFUN (gt, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6710 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6711 @deftypefn {} {@var{TF} =} gt (@var{A}, @var{B})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6712 This function is equivalent to @w{@code{@var{A} > @var{B}}}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6713 @seealso{le, eq, ge, ne, lt}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6714 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6715 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6716 return binary_op_defun_body (octave_value::op_gt, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6717 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6718
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6719 DEFUN (ne, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6720 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6721 @deftypefn {} {@var{TF} =} ne (@var{A}, @var{B})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6722 Return true if the two inputs are not equal.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6723
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6724 This function is equivalent to @w{@code{@var{A} != @var{B}}}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6725 @seealso{eq, isequal, le, ge, lt}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6726 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6727 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6728 return binary_op_defun_body (octave_value::op_ne, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6729 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6730
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6731 DEFUN (times, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6732 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6733 @deftypefn {} {@var{C} =} times (@var{A}, @var{B})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6734 @deftypefnx {} {@var{C} =} times (@var{A1}, @var{A2}, @dots{})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6735 Return the element-by-element multiplication product of inputs.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6736
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6737 This function and @w{@tcode{@var{A} .* @var{B}}} are equivalent.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6738 If more arguments are given, the multiplication is applied
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6739 cumulatively from left to right:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6740
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6741 @example
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6742 (@dots{}((@var{A1} .* @var{A2}) .* @var{A3}) .* @dots{})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6743 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6744
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6745 @seealso{mtimes, rdivide}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6746 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6747 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6748 return binary_assoc_op_defun_body (octave_value::op_el_mul,
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6749 octave_value::op_el_mul_eq, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6750 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6751
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6752 DEFUN (rdivide, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6753 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6754 @deftypefn {} {@var{C} =} rdivide (@var{A}, @var{B})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6755 Return the element-by-element right division of @var{A} and @var{B}.
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6756
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6757 This function and @w{@tcode{@var{A} ./ @var{B}}} are equivalent.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6758 @seealso{ldivide, mrdivide, times, plus}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6759 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6760 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6761 return binary_op_defun_body (octave_value::op_el_div, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6762 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6763
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6764 DEFUN (power, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6765 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6766 @deftypefn {} {@var{C} =} power (@var{A}, @var{B})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6767 Return the element-by-element operation of @var{A} raised to the
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6768 @var{B} power.
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6769
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6770 This function and @w{@tcode{@var{A} .^ @var{B}}} are equivalent.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6771
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6772 If several complex results are possible, returns the one with smallest
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6773 non-negative argument (angle). Use @code{realpow}, @code{realsqrt},
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6774 @code{cbrt}, or @code{nthroot} if a real result is preferred.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6775
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6776 @seealso{mpower, realpow, realsqrt, cbrt, nthroot}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6777 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6778 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6779 return binary_op_defun_body (octave_value::op_el_pow, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6780 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6781
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6782 DEFUN (ldivide, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6783 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6784 @deftypefn {} {@var{C} =} ldivide (@var{A}, @var{B})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6785 Return the element-by-element left division of @var{A} and @var{B}.
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6786
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6787 This function and @w{@tcode{@var{A} .@backslashchar{} @var{B}}} are
24618 c99163d188df doc: Use @var{} around variables in operator functions such as and, or, uplus. Rik <rik@octave.org> parents: 24517 diff changeset	6788 equivalent.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6789 @seealso{rdivide, mldivide, times, plus}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6790 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6791 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6792 return binary_op_defun_body (octave_value::op_el_ldiv, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6793 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6794
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6795 DEFUN (and, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6796 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6797 @deftypefn {} {@var{TF} =} and (@var{x}, @var{y})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6798 @deftypefnx {} {@var{TF} =} and (@var{x1}, @var{x2}, @dots{})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6799 Return the logical AND of @var{x} and @var{y}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6800
24618 c99163d188df doc: Use @var{} around variables in operator functions such as and, or, uplus. Rik <rik@octave.org> parents: 24517 diff changeset	6801 This function is equivalent to the operator syntax
c99163d188df doc: Use @var{} around variables in operator functions such as and, or, uplus. Rik <rik@octave.org> parents: 24517 diff changeset	6802 @w{@code{@var{x} & @var{y}}}. If more than two arguments are given, the
c99163d188df doc: Use @var{} around variables in operator functions such as and, or, uplus. Rik <rik@octave.org> parents: 24517 diff changeset	6803 logical AND is applied cumulatively from left to right:
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6804
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6805 @example
24618 c99163d188df doc: Use @var{} around variables in operator functions such as and, or, uplus. Rik <rik@octave.org> parents: 24517 diff changeset	6806 (@dots{}((@var{x1} & @var{x2}) & @var{x3}) & @dots{})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6807 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6808
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6809 @seealso{or, not, xor}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6810 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6811 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6812 return binary_assoc_op_defun_body (octave_value::op_el_and,
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6813 octave_value::op_el_and_eq, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6814 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6815
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6816 DEFUN (or, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6817 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6818 @deftypefn {} {@var{TF} =} or (@var{x}, @var{y})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	6819 @deftypefnx {} {@var{TF} =} or (@var{x1}, @var{x2}, @dots{})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6820 Return the logical OR of @var{x} and @var{y}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6821
24618 c99163d188df doc: Use @var{} around variables in operator functions such as and, or, uplus. Rik <rik@octave.org> parents: 24517 diff changeset	6822 This function is equivalent to the operator syntax
c99163d188df doc: Use @var{} around variables in operator functions such as and, or, uplus. Rik <rik@octave.org> parents: 24517 diff changeset	6823 @w{@code{@var{x} \| @var{y}}}. If more than two arguments are given, the
c99163d188df doc: Use @var{} around variables in operator functions such as and, or, uplus. Rik <rik@octave.org> parents: 24517 diff changeset	6824 logical OR is applied cumulatively from left to right:
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6825
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6826 @example
24618 c99163d188df doc: Use @var{} around variables in operator functions such as and, or, uplus. Rik <rik@octave.org> parents: 24517 diff changeset	6827 (@dots{}((@var{x1} \| @var{x2}) \| @var{x3}) \| @dots{})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6828 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6829
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6830 @seealso{and, not, xor}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6831 @end deftypefn */)
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6832 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6833 return binary_assoc_op_defun_body (octave_value::op_el_or,
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6834 octave_value::op_el_or_eq, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6835 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6836
19749 c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19743 diff changeset	6837 DEFUN (colon, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6838 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6839 @deftypefn {} {@var{r} =} colon (@var{base}, @var{limit})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6840 @deftypefnx {} {@var{r} =} colon (@var{base}, @var{increment}, @var{limit})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6841 Return the result of the colon expression corresponding to @var{base},
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6842 @var{limit}, and optionally, @var{increment}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6843
24618 c99163d188df doc: Use @var{} around variables in operator functions such as and, or, uplus. Rik <rik@octave.org> parents: 24517 diff changeset	6844 This function is equivalent to the operator syntax
c99163d188df doc: Use @var{} around variables in operator functions such as and, or, uplus. Rik <rik@octave.org> parents: 24517 diff changeset	6845 @w{@code{@var{base} : @var{limit}}} or
c99163d188df doc: Use @var{} around variables in operator functions such as and, or, uplus. Rik <rik@octave.org> parents: 24517 diff changeset	6846 @w{@code{@var{base} : @var{increment} : @var{limit}}}.
24504 5188d936c79a doc: Documentation fixes for linspace, logspace, lookup (bug #52785). Rik <rik@octave.org> parents: 24440 diff changeset	6847 @seealso{linspace}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6848 @end deftypefn */)
19749 c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19743 diff changeset	6849 {
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19743 diff changeset	6850 int nargin = args.length ();
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19743 diff changeset	6851
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6852 if (nargin < 2 \|\| nargin > 3)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6853 print_usage ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6854
28631 70cdf8de553d move non-member octave_value operator functions to octave namespace John W. Eaton <jwe@octave.org> parents: 28115 diff changeset	6855 return (nargin == 2
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	6856 ? colon_op (args(0), args(1))
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	6857 : colon_op (args(0), args(1), args(2)));
19749 c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19743 diff changeset	6858 }
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19743 diff changeset	6859
7065 97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	6860 static double tic_toc_timestamp = -1.0;
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6861
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6862 DEFUN (tic, args, nargout,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6863 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6864 @deftypefn {} {} tic ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6865 @deftypefnx {} {@var{id} =} tic ()
25017 66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6866 Initialize a wall-clock timer.
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6867
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6868 Calling @code{tic} without an output argument resets the internal timer.
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6869 Subsequent calls to @code{toc} return the number of seconds since the timer was
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6870 set.
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6871
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6872 If called with one output argument, @code{tic} creates a new timer instance and
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6873 returns a timer identifier @var{id}. The @var{id} is a scalar of type
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6874 @code{uint64} that may be passed to @code{toc} to check elapsed time on this
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6875 timer, rather than the default internal timer.
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6876
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6877 Example 1 : benchmarking code with internal timer
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6878
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6879 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6880 @group
25017 66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6881 tic;
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6882 # many computations later@dots{}
25017 66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6883 elapsed_time = toc;
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6884 @end group
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6885 @end example
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6886
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6887 Example 2 : mixed timer id and internal timer
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6888
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6889 @example
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6890 @group
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6891 tic;
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6892 pause (1);
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6893 toc
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6894 @result{} Elapsed time is 1.0089 seconds.
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6895 id = tic;
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6896 pause (2);
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6897 toc (id)
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6898 @result{} Elapsed time is 2.01142 seconds.
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6899 toc
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6900 Elapsed time is 3.02308 seconds.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6901 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6902 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6903
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6904 @noindent
25017 66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6905 Calling @code{tic} and @code{toc} in this way allows nested timing calls.
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6906
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6907 If you are more interested in the CPU time that your process used, you should
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6908 use the @code{cputime} function instead. The @code{tic} and @code{toc}
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6909 functions report the actual wall clock time that elapsed between the calls.
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6910 This may include time spent processing other jobs or doing nothing at all.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6911 @seealso{toc, cputime}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6912 @end deftypefn */)
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6913 {
20819 f428cbe7576f eliminate unnecessary uses of nargin John W. Eaton <jwe@octave.org> parents: 20816 diff changeset	6914 if (args.length () != 0)
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6915 warning ("tic: ignoring extra arguments");
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6916
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6917 octave_value retval;
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	6918 sys::time now;
7065 97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	6919 double tmp = now.double_value ();
97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	6920
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6921 if (nargout > 0)
14635 f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6922 {
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6923 double ip = 0.0;
23639 b488e958d024 Use modf, pow from C++ std library. Rik <rik@octave.org> parents: 23625 diff changeset	6924 double frac = std::modf (tmp, &ip);
14635 f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6925 uint64_t microsecs = static_cast<uint64_t> (CLOCKS_PER_SEC * frac);
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6926 microsecs += CLOCKS_PER_SEC * static_cast<uint64_t> (ip);
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6927 retval = octave_uint64 (microsecs);
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6928 }
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6929 else
7065 97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	6930 tic_toc_timestamp = tmp;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	6931
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6932 return retval;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6933 }
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6934
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6935 DEFUN (toc, args, nargout,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6936 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6937 @deftypefn {} {} toc ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6938 @deftypefnx {} {} toc (@var{id})
25017 66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6939 @deftypefnx {} {@var{elapsed_time} =} toc (@dots{})
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6940 Measure elapsed time on a wall-clock timer.
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6941
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6942 With no arguments, return the number of seconds elapsed on the internal timer
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6943 since the last call to @code{tic}.
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6944
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6945 When given the identifier @var{id} of a specific timer, return the number of
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6946 seconds elapsed since the timer @var{id} was initialized.
66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6947
30377 26f2daafa270 doc: Use consistent styling for @ref, @xref, @pxref statements. Rik <rik@octave.org> parents: 30329 diff changeset	6948 @xref{XREFtic,,@code{tic}}, for examples of the use of @code{tic}/@code{toc}.
25017 66c35303d272 doc: Redo documentation for tic and toc. Rik <rik@octave.org> parents: 25003 diff changeset	6949
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6950 @seealso{tic, cputime}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6951 @end deftypefn */)
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6952 {
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6953 int nargin = args.length ();
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6954
14635 f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6955 if (nargin > 1)
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6956 print_usage ();
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6957
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6958 double start_time = tic_toc_timestamp;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6959
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6960 if (nargin == 1)
7065 97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	6961 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6962 octave_uint64 id = args(0).xuint64_scalar_value ("toc: invalid ID");
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6963
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6964 uint64_t val = id.value ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6965
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6966 start_time
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6967 = (static_cast<double> (val / CLOCKS_PER_SEC)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6968 + static_cast<double> (val % CLOCKS_PER_SEC)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6969 / CLOCKS_PER_SEC);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6970
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6971 // FIXME: should we also check to see whether the start
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6972 // time is after the beginning of this Octave session?
7065 97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	6973 }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	6974
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	6975 if (start_time < 0)
28919 7bc983bc2cbd maint: Prepend name of function to error() messages. Rik <rik@octave.org> parents: 28915 diff changeset	6976 error ("toc: function called before timer initialization with tic()");
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6977
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	6978 sys::time now;
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6979
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6980 double etime = now.double_value () - start_time;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6981
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6982 octave_value retval;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6983 if (nargout > 0)
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6984 retval = etime;
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6985 else
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	6986 octave_stdout << "Elapsed time is " << etime << " seconds.\n";
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	6987
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6988 return retval;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6989 }
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6990
14635 f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6991 /*
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6992 %!shared id
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6993 %! id = tic ();
14849 f6d3d5b0bd42 test: Use Octave coding conventions for tests for line() and toc(). Rik <octave@nomad.inbox5.com> parents: 14846 diff changeset	6994 %!assert (isa (id, "uint64"))
f6d3d5b0bd42 test: Use Octave coding conventions for tests for line() and toc(). Rik <octave@nomad.inbox5.com> parents: 14846 diff changeset	6995 %!assert (isa (toc (id), "double"))
14635 f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6996 */
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6997
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6998 DEFUN (cputime, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	6999 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7000 @deftypefn {} {[@var{total}, @var{user}, @var{system}] =} cputime ();
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7001 Return the CPU time used by your Octave session.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7002
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7003 The first output is the total time spent executing your process and is equal
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7004 to the sum of second and third outputs, which are the number of CPU seconds
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7005 spent executing in user mode and the number of CPU seconds spent executing
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7006 in system mode, respectively.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7007
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7008 If your system does not have a way to report CPU time usage, @code{cputime}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7009 returns 0 for each of its output values.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7010
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7011 Note that because Octave used some CPU time to start, it is reasonable
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7012 to check to see if @code{cputime} works by checking to see if the total
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7013 CPU time used is nonzero.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7014 @seealso{tic, toc}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7015 @end deftypefn */)
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	7016 {
21078 49852ff04747 maint: Remove unnecessary declarations of retval. Rik <rik@octave.org> parents: 21062 diff changeset	7017 if (args.length () != 0)
21930 f0c5dd1ea2b9 hide sys/time.h, sys/times.h, and sys/resource.h headers John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	7018 print_usage ();
f0c5dd1ea2b9 hide sys/time.h, sys/times.h, and sys/resource.h headers John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	7019
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	7020 sys::cpu_time cpu_tm;
21930 f0c5dd1ea2b9 hide sys/time.h, sys/times.h, and sys/resource.h headers John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	7021
f0c5dd1ea2b9 hide sys/time.h, sys/times.h, and sys/resource.h headers John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	7022 double usr = cpu_tm.user ();
f0c5dd1ea2b9 hide sys/time.h, sys/times.h, and sys/resource.h headers John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	7023 double sys = cpu_tm.system ();
f0c5dd1ea2b9 hide sys/time.h, sys/times.h, and sys/resource.h headers John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	7024
f0c5dd1ea2b9 hide sys/time.h, sys/times.h, and sys/resource.h headers John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	7025 return ovl (usr + sys, usr, sys);
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	7026 }
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	7027
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7028 DEFUN (sort, args, nargout,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7029 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7030 @deftypefn {} {[@var{s}, @var{i}] =} sort (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7031 @deftypefnx {} {[@var{s}, @var{i}] =} sort (@var{x}, @var{dim})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7032 @deftypefnx {} {[@var{s}, @var{i}] =} sort (@var{x}, @var{mode})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7033 @deftypefnx {} {[@var{s}, @var{i}] =} sort (@var{x}, @var{dim}, @var{mode})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7034 Return a copy of @var{x} with the elements arranged in increasing order.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7035
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7036 For matrices, @code{sort} orders the elements within columns
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7037
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7038 For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7039
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7040 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7041 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7042 sort ([1, 2; 2, 3; 3, 1])
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7043 @result{} 1 1
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7044 2 2
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7045 3 3
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7046 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7047 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7048
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7049 If the optional argument @var{dim} is given, then the matrix is sorted
25471 e0906c38f18e doc: Use @var rather than @code to mark third argument to sort in docstring. Rik <rik@octave.org> parents: 25286 diff changeset	7050 along the dimension defined by @var{dim}. The optional argument @var{mode}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7051 defines the order in which the values will be sorted. Valid values of
25471 e0906c38f18e doc: Use @var rather than @code to mark third argument to sort in docstring. Rik <rik@octave.org> parents: 25286 diff changeset	7052 @var{mode} are @qcode{"ascend"} or @qcode{"descend"}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7053
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7054 The @code{sort} function may also be used to produce a matrix
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7055 containing the original row indices of the elements in the sorted
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7056 matrix. For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7057
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7058 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7059 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7060 [s, i] = sort ([1, 2; 2, 3; 3, 1])
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7061 @result{} s = 1 1
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7062 2 2
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7063 3 3
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7064 @result{} i = 1 3
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7065 2 1
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7066 3 2
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7067 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7068 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7069
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7070 For equal elements, the indices are such that equal elements are listed
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7071 in the order in which they appeared in the original list.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7072
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7073 Sorting of complex entries is done first by magnitude
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7074 (@w{@code{abs (@var{z})}}) and for any ties by phase angle
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7075 (@w{@code{angle (z)}}). For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7076
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7077 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7078 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7079 sort ([1+i; 1; 1-i])
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7080 @result{} 1 + 0i
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7081 1 - 1i
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7082 1 + 1i
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7083 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7084 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7085
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7086 NaN values are treated as being greater than any other value and are sorted
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7087 to the end of the list.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7088
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7089 The @code{sort} function may also be used to sort strings and cell arrays
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7090 of strings, in which case ASCII dictionary order (uppercase 'A' precedes
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7091 lowercase 'a') of the strings is used.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7092
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7093 The algorithm used in @code{sort} is optimized for the sorting of partially
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7094 ordered lists.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7095 @seealso{sortrows, issorted}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7096 @end deftypefn */)
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7097 {
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7098 int nargin = args.length ();
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7099
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7100 if (nargin < 1 \|\| nargin > 3)
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7101 print_usage ();
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7102
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20853 diff changeset	7103 sortmode smode = ASCENDING;
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20853 diff changeset	7104 bool return_idx = (nargout > 1);
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20918 diff changeset	7105 bool have_sortmode = (nargin > 1 && args(1).is_string ());
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7106 octave_value arg = args(0);
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7107
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7108 int dim = 0;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7109 if (nargin > 1)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7110 {
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20853 diff changeset	7111 if (have_sortmode)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	7112 {
14846 460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists. Rik <octave@nomad.inbox5.com> parents: 14843 diff changeset	7113 std::string mode = args(1).string_value ();
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	7114 if (mode == "ascend")
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	7115 smode = ASCENDING;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	7116 else if (mode == "descend")
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	7117 smode = DESCENDING;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	7118 else
23803 90689bdbe048 Use C++11 raw string literals to avoid escaping double quotes. Rik <rik@octave.org> parents: 23748 diff changeset	7119 error (R"(sort: MODE must be either "ascend" or "descend")");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	7120 }
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7121 else
33271 59ee9d370307 Better input validation for sort() function (bug #65527) Rik <rik@octave.org> parents: 33250 diff changeset	7122 {
33555 a8346c5f6997 Fix 2-output form of sort() for dim > ndims() (bug #65712) Arun Giridhar <arungiridhar@gmail.com> parents: 33544 diff changeset	7123 // Require dim to be positive real scalar.
a8346c5f6997 Fix 2-output form of sort() for dim > ndims() (bug #65712) Arun Giridhar <arungiridhar@gmail.com> parents: 33544 diff changeset	7124 if (! args(1).is_scalar_type () \|\| args(1).iscomplex ()
a8346c5f6997 Fix 2-output form of sort() for dim > ndims() (bug #65712) Arun Giridhar <arungiridhar@gmail.com> parents: 33544 diff changeset	7125 \|\| args(1).double_value () <= 0)
33271 59ee9d370307 Better input validation for sort() function (bug #65527) Rik <rik@octave.org> parents: 33250 diff changeset	7126 error ("sort: DIM must be a positive scalar integer");
33544 31bc9accbe6e data.cc: Add back input validation from 85c8686b78e9 Arun Giridhar <arungiridhar@gmail.com> parents: 33543 diff changeset	7127
31bc9accbe6e data.cc: Add back input validation from 85c8686b78e9 Arun Giridhar <arungiridhar@gmail.com> parents: 33543 diff changeset	7128 // Forbid fractional value input, also nan input.
31bc9accbe6e data.cc: Add back input validation from 85c8686b78e9 Arun Giridhar <arungiridhar@gmail.com> parents: 33543 diff changeset	7129 dim = args(1).strict_int_value ("sort: DIM must be a positive scalar integer") - 1;
33271 59ee9d370307 Better input validation for sort() function (bug #65527) Rik <rik@octave.org> parents: 33250 diff changeset	7130 }
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7131 }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7132
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7133 if (nargin > 2)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7134 {
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20853 diff changeset	7135 if (have_sortmode)
33271 59ee9d370307 Better input validation for sort() function (bug #65527) Rik <rik@octave.org> parents: 33250 diff changeset	7136 error ("sort: DIM argument must precede MODE argument");
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7137
20700 68e3a747ca02 rename octave_value value extractors that accept error message args John W. Eaton <jwe@octave.org> parents: 20652 diff changeset	7138 std::string mode = args(2).xstring_value ("sort: MODE must be a string");
20582 ba2b07c13913 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20574 diff changeset	7139
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7140 if (mode == "ascend")
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	7141 smode = ASCENDING;
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7142 else if (mode == "descend")
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	7143 smode = DESCENDING;
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7144 else
23803 90689bdbe048 Use C++11 raw string literals to avoid escaping double quotes. Rik <rik@octave.org> parents: 23748 diff changeset	7145 error (R"(sort: MODE must be either "ascend" or "descend")");
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7146 }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7147
10285 22a7913bbeb5 optimize return values of find and sort Jaroslav Hajek <highegg@gmail.com> parents: 10277 diff changeset	7148 const dim_vector dv = arg.dims ();
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20853 diff changeset	7149 if (nargin == 1 \|\| have_sortmode)
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7150 {
10285 22a7913bbeb5 optimize return values of find and sort Jaroslav Hajek <highegg@gmail.com> parents: 10277 diff changeset	7151 dim = dv.first_non_singleton ();
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7152 }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7153
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20853 diff changeset	7154 octave_value_list retval (return_idx ? 2 : 1);
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20853 diff changeset	7155
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7156 if (return_idx)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7157 {
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7158 Array<octave_idx_type> sidx;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7159
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20853 diff changeset	7160 // NOTE: Can not change this to ovl() call because arg.sort changes sidx
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20853 diff changeset	7161 // and objects are declared const in ovl prototype.
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	7162 retval(0) = arg.sort (sidx, dim, smode);
33555 a8346c5f6997 Fix 2-output form of sort() for dim > ndims() (bug #65712) Arun Giridhar <arungiridhar@gmail.com> parents: 33544 diff changeset	7163 // Check for index dimension extent. Set to 1 for dimension >= ndims ()
a8346c5f6997 Fix 2-output form of sort() for dim > ndims() (bug #65712) Arun Giridhar <arungiridhar@gmail.com> parents: 33544 diff changeset	7164 retval(1) = idx_vector (sidx, (dim < arg.ndims ()) ? dv(dim) : 1);
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7165 }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7166 else
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20853 diff changeset	7167 retval = ovl (arg.sort (dim, smode));
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7168
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7169 return retval;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7170 }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7171
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7172 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7173 ## Double
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7174 %!assert (sort ([NaN, 1, -1, 2, Inf]), [-1, 1, 2, Inf, NaN])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7175 %!assert (sort ([NaN, 1, -1, 2, Inf], 1), [NaN, 1, -1, 2, Inf])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7176 %!assert (sort ([NaN, 1, -1, 2, Inf], 2), [-1, 1, 2, Inf, NaN])
10707 69c5f5ec55d7 fix invalid sort tests Jaroslav Hajek <highegg@gmail.com> parents: 10703 diff changeset	7177 %!assert (sort ([NaN, 1, -1, 2, Inf], 3), [NaN, 1, -1, 2, Inf])
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7178 %!assert (sort ([NaN, 1, -1, 2, Inf], "ascend"), [-1, 1, 2, Inf, NaN])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7179 %!assert (sort ([NaN, 1, -1, 2, Inf], 2, "ascend"), [-1, 1, 2, Inf, NaN])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7180 %!assert (sort ([NaN, 1, -1, 2, Inf], "descend"), [NaN, Inf, 2, 1, -1])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7181 %!assert (sort ([NaN, 1, -1, 2, Inf], 2, "descend"), [NaN, Inf, 2, 1, -1])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7182 %!assert (sort ([3, 1, 7, 5; 8, 2, 6, 4]), [3, 1, 6, 4; 8, 2, 7, 5])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7183 %!assert (sort ([3, 1, 7, 5; 8, 2, 6, 4], 1), [3, 1, 6, 4; 8, 2, 7, 5])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7184 %!assert (sort ([3, 1, 7, 5; 8, 2, 6, 4], 2), [1, 3, 5, 7; 2, 4, 6, 8])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7185 %!assert (sort (1), 1)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7186
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7187 %!test
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7188 %! [v, i] = sort ([NaN, 1, -1, Inf, 1]);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7189 %! assert (v, [-1, 1, 1, Inf, NaN]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7190 %! assert (i, [3, 2, 5, 4, 1]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7191
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7192 ## Complex
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7193 %!assert (sort ([NaN, 1i, -1, 2, Inf]), [1i, -1, 2, Inf, NaN])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7194 %!assert (sort ([NaN, 1i, -1, 2, Inf], 1), [NaN, 1i, -1, 2, Inf])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7195 %!assert (sort ([NaN, 1i, -1, 2, Inf], 2), [1i, -1, 2, Inf, NaN])
10707 69c5f5ec55d7 fix invalid sort tests Jaroslav Hajek <highegg@gmail.com> parents: 10703 diff changeset	7196 %!assert (sort ([NaN, 1i, -1, 2, Inf], 3), [NaN, 1i, -1, 2, Inf])
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7197 %!assert (sort ([NaN, 1i, -1, 2, Inf], "ascend"), [1i, -1, 2, Inf, NaN])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7198 %!assert (sort ([NaN, 1i, -1, 2, Inf], 2, "ascend"), [1i, -1, 2, Inf, NaN])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7199 %!assert (sort ([NaN, 1i, -1, 2, Inf], "descend"), [NaN, Inf, 2, -1, 1i])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7200 %!assert (sort ([NaN, 1i, -1, 2, Inf], 2, "descend"), [NaN, Inf, 2, -1, 1i])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7201 %!assert (sort ([3, 1i, 7, 5; 8, 2, 6, 4]), [3, 1i, 6, 4; 8, 2, 7, 5])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7202 %!assert (sort ([3, 1i, 7, 5; 8, 2, 6, 4], 1), [3, 1i, 6, 4; 8, 2, 7, 5])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7203 %!assert (sort ([3, 1i, 7, 5; 8, 2, 6, 4], 2), [1i, 3, 5, 7; 2, 4, 6, 8])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7204 %!assert (sort (1i), 1i)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7205
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7206 %!test
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7207 %! [v, i] = sort ([NaN, 1i, -1, Inf, 1, 1i]);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7208 %! assert (v, [1, 1i, 1i, -1, Inf, NaN]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7209 %! assert (i, [5, 2, 6, 3, 4, 1]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7210
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7211 ## Single
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7212 %!assert (sort (single ([NaN, 1, -1, 2, Inf])), single ([-1, 1, 2, Inf, NaN]))
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7213 %!assert (sort (single ([NaN, 1, -1, 2, Inf]), 1),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7214 %! single ([NaN, 1, -1, 2, Inf]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7215 %!assert (sort (single ([NaN, 1, -1, 2, Inf]), 2),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7216 %! single ([-1, 1, 2, Inf, NaN]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7217 %!assert (sort (single ([NaN, 1, -1, 2, Inf]), 3),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7218 %! single ([NaN, 1, -1, 2, Inf]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7219 %!assert (sort (single ([NaN, 1, -1, 2, Inf]), "ascend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7220 %! single ([-1, 1, 2, Inf, NaN]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7221 %!assert (sort (single ([NaN, 1, -1, 2, Inf]), 2, "ascend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7222 %! single ([-1, 1, 2, Inf, NaN]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7223 %!assert (sort (single ([NaN, 1, -1, 2, Inf]), "descend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7224 %! single ([NaN, Inf, 2, 1, -1]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7225 %!assert (sort (single ([NaN, 1, -1, 2, Inf]), 2, "descend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7226 %! single ([NaN, Inf, 2, 1, -1]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7227 %!assert (sort (single ([3, 1, 7, 5; 8, 2, 6, 4])),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7228 %! single ([3, 1, 6, 4; 8, 2, 7, 5]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7229 %!assert (sort (single ([3, 1, 7, 5; 8, 2, 6, 4]), 1),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7230 %! single ([3, 1, 6, 4; 8, 2, 7, 5]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7231 %!assert (sort (single ([3, 1, 7, 5; 8, 2, 6, 4]), 2),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7232 %! single ([1, 3, 5, 7; 2, 4, 6, 8]))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7233 %!assert (sort (single (1)), single (1))
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	7234
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	7235 %!test
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7236 %! [v, i] = sort (single ([NaN, 1, -1, Inf, 1]));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7237 %! assert (v, single ([-1, 1, 1, Inf, NaN]));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7238 %! assert (i, [3, 2, 5, 4, 1]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7239
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7240 ## Single Complex
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7241 %!assert (sort (single ([NaN, 1i, -1, 2, Inf])), single ([1i, -1, 2, Inf, NaN]))
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7242 %!assert (sort (single ([NaN, 1i, -1, 2, Inf]), 1),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7243 %! single ([NaN, 1i, -1, 2, Inf]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7244 %!assert (sort (single ([NaN, 1i, -1, 2, Inf]), 2),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7245 %! single ([1i, -1, 2, Inf, NaN]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7246 %!assert (sort (single ([NaN, 1i, -1, 2, Inf]), 3),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7247 %! single ([NaN, 1i, -1, 2, Inf]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7248 %!assert (sort (single ([NaN, 1i, -1, 2, Inf]), "ascend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7249 %! single ([1i, -1, 2, Inf, NaN]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7250 %!assert (sort (single ([NaN, 1i, -1, 2, Inf]), 2, "ascend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7251 %! single ([1i, -1, 2, Inf, NaN]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7252 %!assert (sort (single ([NaN, 1i, -1, 2, Inf]), "descend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7253 %! single ([NaN, Inf, 2, -1, 1i]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7254 %!assert (sort (single ([NaN, 1i, -1, 2, Inf]), 2, "descend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7255 %! single ([NaN, Inf, 2, -1, 1i]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7256 %!assert (sort (single ([3, 1i, 7, 5; 8, 2, 6, 4])),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7257 %! single ([3, 1i, 6, 4; 8, 2, 7, 5]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7258 %!assert (sort (single ([3, 1i, 7, 5; 8, 2, 6, 4]), 1),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7259 %! single ([3, 1i, 6, 4; 8, 2, 7, 5]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7260 %!assert (sort (single ([3, 1i, 7, 5; 8, 2, 6, 4]), 2),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7261 %! single ([1i, 3, 5, 7; 2, 4, 6, 8]))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7262 %!assert (sort (single (1i)), single (1i))
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	7263
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	7264 %!test
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7265 %! [v, i] = sort (single ([NaN, 1i, -1, Inf, 1, 1i]));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7266 %! assert (v, single ([1, 1i, 1i, -1, Inf, NaN]));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7267 %! assert (i, [5, 2, 6, 3, 4, 1]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7268
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7269 ## Bool
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7270 %!assert (sort ([true, false, true, false]), [false, false, true, true])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7271 %!assert (sort ([true, false, true, false], 1), [true, false, true, false])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7272 %!assert (sort ([true, false, true, false], 2), [false, false, true, true])
10707 69c5f5ec55d7 fix invalid sort tests Jaroslav Hajek <highegg@gmail.com> parents: 10703 diff changeset	7273 %!assert (sort ([true, false, true, false], 3), [true, false, true, false])
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7274 %!assert (sort ([true, false, true, false], "ascend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7275 %! [false, false, true, true])
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7276 %!assert (sort ([true, false, true, false], 2, "ascend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7277 %! [false, false, true, true])
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7278 %!assert (sort ([true, false, true, false], "descend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7279 %! [true, true, false, false])
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7280 %!assert (sort ([true, false, true, false], 2, "descend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7281 %! [true, true, false, false])
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7282 %!assert (sort (true), true)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7283
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7284 %!test
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7285 %! [v, i] = sort ([true, false, true, false]);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7286 %! assert (v, [false, false, true, true]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7287 %! assert (i, [2, 4, 1, 3]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7288
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7289 ## Sparse Double
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7290 %!assert (sort (sparse ([0, NaN, 1, 0, -1, 2, Inf])),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7291 %! sparse ([-1, 0, 0, 1, 2, Inf, NaN]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7292 %!assert (sort (sparse ([0, NaN, 1, 0, -1, 2, Inf]), 1),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7293 %! sparse ([0, NaN, 1, 0, -1, 2, Inf]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7294 %!assert (sort (sparse ([0, NaN, 1, 0, -1, 2, Inf]), 2),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7295 %! sparse ([-1, 0, 0, 1, 2, Inf, NaN]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7296 %!assert (sort (sparse ([0, NaN, 1, 0, -1, 2, Inf]), 3),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7297 %! sparse ([0, NaN, 1, 0, -1, 2, Inf]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7298 %!assert (sort (sparse ([0, NaN, 1, 0, -1, 2, Inf]), "ascend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7299 %! sparse ([-1, 0, 0, 1, 2, Inf, NaN]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7300 %!assert (sort (sparse ([0, NaN, 1, 0, -1, 2, Inf]), 2, "ascend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7301 %! sparse ([-1, 0, 0, 1, 2, Inf, NaN]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7302 %!assert (sort (sparse ([0, NaN, 1, 0, -1, 2, Inf]), "descend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7303 %! sparse ([NaN, Inf, 2, 1, 0, 0, -1]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7304 %!assert (sort (sparse ([0, NaN, 1, 0, -1, 2, Inf]), 2, "descend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7305 %! sparse ([NaN, Inf, 2, 1, 0, 0, -1]))
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7306
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7307 %!shared a
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7308 %! a = randn (10, 10);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7309 %! a(a < 0) = 0;
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7310 %!assert (sort (sparse (a)), sparse (sort (a)))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7311 %!assert (sort (sparse (a), 1), sparse (sort (a, 1)))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7312 %!assert (sort (sparse (a), 2), sparse (sort (a, 2)))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7313 %!test
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7314 %! [v, i] = sort (a);
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7315 %! [vs, is] = sort (sparse (a));
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7316 %! assert (vs, sparse (v));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7317 %! assert (is, i);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7318
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7319 ## Sparse Complex
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7320 %!assert (sort (sparse ([0, NaN, 1i, 0, -1, 2, Inf])),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7321 %! sparse ([0, 0, 1i, -1, 2, Inf, NaN]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7322 %!assert (sort (sparse ([0, NaN, 1i, 0, -1, 2, Inf]), 1),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7323 %! sparse ([0, NaN, 1i, 0, -1, 2, Inf]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7324 %!assert (sort (sparse ([0, NaN, 1i, 0, -1, 2, Inf]), 2),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7325 %! sparse ([0, 0, 1i, -1, 2, Inf, NaN]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7326 %!assert (sort (sparse ([0, NaN, 1i, 0, -1, 2, Inf]), 3),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7327 %! sparse ([0, NaN, 1i, 0, -1, 2, Inf]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7328 %!assert (sort (sparse ([0, NaN, 1i, 0, -1, 2, Inf]), "ascend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7329 %! sparse ([0, 0, 1i, -1, 2, Inf, NaN]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7330 %!assert (sort (sparse ([0, NaN, 1i, 0, -1, 2, Inf]), 2, "ascend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7331 %! sparse ([0, 0, 1i, -1, 2, Inf, NaN]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7332 %!assert (sort (sparse ([0, NaN, 1i, 0, -1, 2, Inf]), "descend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7333 %! sparse ([NaN, Inf, 2, -1, 1i, 0, 0]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7334 %!assert (sort (sparse ([0, NaN, 1i, 0, -1, 2, Inf]), 2, "descend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7335 %! sparse ([NaN, Inf, 2, -1, 1i, 0, 0]))
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7336
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7337 %!shared a
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	7338 %! a = randn (10, 10);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7339 %! a(a < 0) = 0;
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7340 %! a = 1i * a;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7341 %!assert (sort (sparse (a)), sparse (sort (a)))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7342 %!assert (sort (sparse (a), 1), sparse (sort (a, 1)))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7343 %!assert (sort (sparse (a), 2), sparse (sort (a, 2)))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7344 %!test
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7345 %! [v, i] = sort (a);
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7346 %! [vs, is] = sort (sparse (a));
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7347 %! assert (vs, sparse (v));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7348 %! assert (is, i);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7349
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7350 ## Sparse Bool
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7351 %!assert (sort (sparse ([true, false, true, false])),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7352 %! sparse ([false, false, true, true]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7353 %!assert (sort (sparse ([true, false, true, false]), 1),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7354 %! sparse ([true, false, true, false]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7355 %!assert (sort (sparse ([true, false, true, false]), 2),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7356 %! sparse ([false, false, true, true]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7357 %!assert (sort (sparse ([true, false, true, false]), 3),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7358 %! sparse ([true, false, true, false]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7359 %!assert (sort (sparse ([true, false, true, false]), "ascend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7360 %! sparse ([false, false, true, true]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7361 %!assert (sort (sparse ([true, false, true, false]), 2, "ascend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7362 %! sparse ([false, false, true, true]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7363 %!assert (sort (sparse ([true, false, true, false]), "descend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7364 %! sparse ([true, true, false, false]))
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7365 %!assert (sort (sparse ([true, false, true, false]), 2, "descend"),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 30329 diff changeset	7366 %! sparse ([true, true, false, false]))
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7367
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7368 %!test
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7369 %! [v, i] = sort (sparse ([true, false, true, false]));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7370 %! assert (v, sparse ([false, false, true, true]));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7371 %! assert (i, [2, 4, 1, 3]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7372
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7373 ## Cell string array
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7374 %!shared a, b, c
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7375 %! a = {"Alice", "Cecile", "Eric", "Barry", "David"};
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7376 %! b = {"Alice", "Barry", "Cecile", "David", "Eric"};
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7377 %! c = {"Eric", "David", "Cecile", "Barry", "Alice"};
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7378 %!assert (sort (a), b)
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7379 %!assert (sort (a, 1), a)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7380 %!assert (sort (a, 2), b)
10707 69c5f5ec55d7 fix invalid sort tests Jaroslav Hajek <highegg@gmail.com> parents: 10703 diff changeset	7381 %!assert (sort (a, 3), a)
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7382 %!assert (sort (a, "ascend"), b)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7383 %!assert (sort (a, 2, "ascend"), b)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7384 %!assert (sort (a, "descend"), c)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7385 %!assert (sort (a, 2, "descend"), c)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7386
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7387 %!test
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7388 %! [v, i] = sort (a);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7389 %! assert (i, [1, 4, 2, 5, 3]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7390
33543 8f73f8534d42 Return early if sort dimension exceeds array dimension (bug #65712) Arun Giridhar <arungiridhar@gmail.com> parents: 33541 diff changeset	7391 ## Test sort dimension being very large
8f73f8534d42 Return early if sort dimension exceeds array dimension (bug #65712) Arun Giridhar <arungiridhar@gmail.com> parents: 33541 diff changeset	7392 %!test <*65712>
8f73f8534d42 Return early if sort dimension exceeds array dimension (bug #65712) Arun Giridhar <arungiridhar@gmail.com> parents: 33541 diff changeset	7393 %! A = [1 2; 3 4];
8f73f8534d42 Return early if sort dimension exceeds array dimension (bug #65712) Arun Giridhar <arungiridhar@gmail.com> parents: 33541 diff changeset	7394 %! assert (sort (A, 100), A)
8f73f8534d42 Return early if sort dimension exceeds array dimension (bug #65712) Arun Giridhar <arungiridhar@gmail.com> parents: 33541 diff changeset	7395 %! assert (sort (A, inf), A)
33555 a8346c5f6997 Fix 2-output form of sort() for dim > ndims() (bug #65712) Arun Giridhar <arungiridhar@gmail.com> parents: 33544 diff changeset	7396 %! [B, idx] = sort (A, 100);
a8346c5f6997 Fix 2-output form of sort() for dim > ndims() (bug #65712) Arun Giridhar <arungiridhar@gmail.com> parents: 33544 diff changeset	7397 %! assert (B, A);
a8346c5f6997 Fix 2-output form of sort() for dim > ndims() (bug #65712) Arun Giridhar <arungiridhar@gmail.com> parents: 33544 diff changeset	7398 %! assert (idx, ones (2))
a8346c5f6997 Fix 2-output form of sort() for dim > ndims() (bug #65712) Arun Giridhar <arungiridhar@gmail.com> parents: 33544 diff changeset	7399 %! [B, idx] = sort (A, inf);
a8346c5f6997 Fix 2-output form of sort() for dim > ndims() (bug #65712) Arun Giridhar <arungiridhar@gmail.com> parents: 33544 diff changeset	7400 %! assert (B, A);
a8346c5f6997 Fix 2-output form of sort() for dim > ndims() (bug #65712) Arun Giridhar <arungiridhar@gmail.com> parents: 33544 diff changeset	7401 %! assert (idx, ones (2))
33543 8f73f8534d42 Return early if sort dimension exceeds array dimension (bug #65712) Arun Giridhar <arungiridhar@gmail.com> parents: 33541 diff changeset	7402
33271 59ee9d370307 Better input validation for sort() function (bug #65527) Rik <rik@octave.org> parents: 33250 diff changeset	7403 %!error <Invalid call> sort ()
59ee9d370307 Better input validation for sort() function (bug #65527) Rik <rik@octave.org> parents: 33250 diff changeset	7404 %!error <Invalid call> sort (1, 2, 3, 4)
59ee9d370307 Better input validation for sort() function (bug #65527) Rik <rik@octave.org> parents: 33250 diff changeset	7405 %!error <MODE must be either "ascend" or "descend"> sort (1, "foobar")
59ee9d370307 Better input validation for sort() function (bug #65527) Rik <rik@octave.org> parents: 33250 diff changeset	7406 %!error <DIM must be a positive scalar integer> sort (1, [1 2 3])
33555 a8346c5f6997 Fix 2-output form of sort() for dim > ndims() (bug #65712) Arun Giridhar <arungiridhar@gmail.com> parents: 33544 diff changeset	7407 %!error <DIM must be a positive scalar integer> sort ([1 2; 3 4], -inf)
a8346c5f6997 Fix 2-output form of sort() for dim > ndims() (bug #65712) Arun Giridhar <arungiridhar@gmail.com> parents: 33544 diff changeset	7408 %!error <DIM must be a positive scalar integer> sort ([1 2; 3 4], 0)
a8346c5f6997 Fix 2-output form of sort() for dim > ndims() (bug #65712) Arun Giridhar <arungiridhar@gmail.com> parents: 33544 diff changeset	7409 %!error <DIM must be a positive scalar integer> sort ([1 2; 3 4], 1+i)
33544 31bc9accbe6e data.cc: Add back input validation from 85c8686b78e9 Arun Giridhar <arungiridhar@gmail.com> parents: 33543 diff changeset	7410 %!error <DIM must be a positive scalar integer> sort ([1 2; 3 4], 1.234)
31bc9accbe6e data.cc: Add back input validation from 85c8686b78e9 Arun Giridhar <arungiridhar@gmail.com> parents: 33543 diff changeset	7411 %!error <DIM must be a positive scalar integer> sort ([1 2; 3 4], nan)
33271 59ee9d370307 Better input validation for sort() function (bug #65527) Rik <rik@octave.org> parents: 33250 diff changeset	7412 %!error <DIM argument must precede MODE argument> sort (1, "ascend", 1)
59ee9d370307 Better input validation for sort() function (bug #65527) Rik <rik@octave.org> parents: 33250 diff changeset	7413 %!error <MODE must be a string> sort (1, 1, 1)
59ee9d370307 Better input validation for sort() function (bug #65527) Rik <rik@octave.org> parents: 33250 diff changeset	7414 %!error <MODE must be either "ascend" or "descend"> sort (1, 1, "foobar")
59ee9d370307 Better input validation for sort() function (bug #65527) Rik <rik@octave.org> parents: 33250 diff changeset	7415 %!error <DIM must be a positive scalar integer> sort (1, 0)
59ee9d370307 Better input validation for sort() function (bug #65527) Rik <rik@octave.org> parents: 33250 diff changeset	7416
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7417 */
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7418
30891 79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7419 // Sort the rows of the matrix @var{a} according to the order
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7420 // specified by @var{mode}, which can either be 'ascend' or 'descend'
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7421 // and return the index vector corresponding to the sort order.
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7422 //
30892 1a3cc2811090 doc: Update documentation for __sort_rows_idx__. Rik <rik@octave.org> parents: 30891 diff changeset	7423 // FIXME: This function does not yet support sparse matrices.
1a3cc2811090 doc: Update documentation for __sort_rows_idx__. Rik <rik@octave.org> parents: 30891 diff changeset	7424
30891 79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7425 DEFUN (__sort_rows_idx__, args, ,
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7426 doc: /* -- texinfo --
30892 1a3cc2811090 doc: Update documentation for __sort_rows_idx__. Rik <rik@octave.org> parents: 30891 diff changeset	7427 @deftypefn {} {@var{idx} =} __sort_rows_idx__ (@var{A}, @var{mode})
1a3cc2811090 doc: Update documentation for __sort_rows_idx__. Rik <rik@octave.org> parents: 30891 diff changeset	7428 Called internally from @file{sortrows.m}.
30891 79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7429 @end deftypefn */)
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7430 {
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7431 int nargin = args.length ();
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7432
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7433 if (nargin < 1 \|\| nargin > 2)
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7434 print_usage ();
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7435
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7436 if (nargin == 2 && ! args(1).is_string ())
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7437 error ("__sort_rows_idx__: second argument must be a string");
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7438
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7439 sortmode smode = ASCENDING;
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7440 if (nargin > 1)
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7441 {
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7442 std::string mode = args(1).string_value ();
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7443 if (mode == "ascend")
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7444 smode = ASCENDING;
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7445 else if (mode == "descend")
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7446 smode = DESCENDING;
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7447 else
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7448 error (R"(__sort_rows_idx__: MODE must be either "ascend" or "descend")");
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7449 }
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7450
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7451 octave_value arg = args(0);
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7452
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7453 if (arg.issparse ())
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7454 error ("__sort_rows_idx__: sparse matrices not yet supported");
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7455
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7456 if (arg.ndims () != 2)
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7457 error ("__sort_rows_idx__: needs a 2-D object");
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7458
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7459 Array<octave_idx_type> idx = arg.sort_rows_idx (smode);
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7460
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7461 // This cannot be ovl(), relies on special overloaded octave_value call.
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7462 return octave_value (idx, true, true);
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7463 }
79b3c0b5c265 maint: Backed out changeset 3a15bf04cb7f (__sort_rows_idx__ is used). Rik <rik@octave.org> parents: 30889 diff changeset	7464
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7465 static sortmode
20720 7c21b151b8b4 build: Fix warning messages from compiler. Rik <rik@octave.org> parents: 20711 diff changeset	7466 get_sort_mode_option (const octave_value& arg)
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7467 {
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7468 // FIXME: we initialize to UNSORTED here to avoid a GCC warning
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	7469 // about possibly using sortmode uninitialized.
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7470 // FIXME: shouldn't these modes be scoped inside a class?
10076 4b270d1540f7 avoid various GCC warnings John W. Eaton <jwe@octave.org> parents: 10073 diff changeset	7471 sortmode smode = UNSORTED;
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7472
20711 7b608fadc663 Make error messages more specific about the variable and problem encountered. Rik <rik@octave.org> parents: 20704 diff changeset	7473 std::string mode = arg.xstring_value ("issorted: MODE must be a string");
20582 ba2b07c13913 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20574 diff changeset	7474
25484 b7db401e1a99 Use "ascend"/"descend" for issorted direction (bug #54147). Rik <rik@octave.org> parents: 25473 diff changeset	7475 if (mode == "ascend")
20582 ba2b07c13913 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20574 diff changeset	7476 smode = ASCENDING;
25484 b7db401e1a99 Use "ascend"/"descend" for issorted direction (bug #54147). Rik <rik@octave.org> parents: 25473 diff changeset	7477 else if (mode == "descend")
20582 ba2b07c13913 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20574 diff changeset	7478 smode = DESCENDING;
ba2b07c13913 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20574 diff changeset	7479 else if (mode == "either")
ba2b07c13913 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20574 diff changeset	7480 smode = UNSORTED;
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7481 else
25484 b7db401e1a99 Use "ascend"/"descend" for issorted direction (bug #54147). Rik <rik@octave.org> parents: 25473 diff changeset	7482 error (R"(issorted: MODE must be "ascend", "descend", or "either")");
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7483
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7484 return smode;
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7485 }
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7486
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7487 DEFUN (issorted, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7488 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	7489 @deftypefn {} {@var{tf} =} issorted (@var{A})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	7490 @deftypefnx {} {@var{tf} =} issorted (@var{A}, @var{mode})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	7491 @deftypefnx {} {@var{tf} =} issorted (@var{A}, "rows", @var{mode})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	7492 Return true if the vector @var{A} is sorted according to @var{mode}, which
30594 0cb3f48da9da doc: clarifies issorted only operates on vectors (bug #61765) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 30565 diff changeset	7493 may be either @qcode{"ascend"}, @qcode{"descend"}, or @qcode{"either"}.
27034 df32e0cf0992 doc: Fix names of options in issorted (bug #56087). Rik <rik@octave.org> parents: 26376 diff changeset	7494
df32e0cf0992 doc: Fix names of options in issorted (bug #56087). Rik <rik@octave.org> parents: 26376 diff changeset	7495 By default, @var{mode} is @qcode{"ascend"}. NaNs are treated in the same
df32e0cf0992 doc: Fix names of options in issorted (bug #56087). Rik <rik@octave.org> parents: 26376 diff changeset	7496 manner as @code{sort}.
df32e0cf0992 doc: Fix names of options in issorted (bug #56087). Rik <rik@octave.org> parents: 26376 diff changeset	7497
30594 0cb3f48da9da doc: clarifies issorted only operates on vectors (bug #61765) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 30565 diff changeset	7498 If the optional argument @qcode{"rows"} is supplied, check whether the matrix
0cb3f48da9da doc: clarifies issorted only operates on vectors (bug #61765) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 30565 diff changeset	7499 is sorted by rows as output by the function @code{sortrows} (with no options).
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7500
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7501 This function does not support sparse matrices.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7502 @seealso{sort, sortrows}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7503 @end deftypefn */)
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7504 {
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7505 int nargin = args.length ();
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7506
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7507 if (nargin < 1 \|\| nargin > 3)
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7508 print_usage ();
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7509
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7510 bool by_rows = false;
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7511
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7512 sortmode smode = ASCENDING;
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7513
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7514 if (nargin > 1)
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7515 {
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7516 if (nargin == 3)
20720 7c21b151b8b4 build: Fix warning messages from compiler. Rik <rik@octave.org> parents: 20711 diff changeset	7517 smode = get_sort_mode_option (args(2));
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7518
20700 68e3a747ca02 rename octave_value value extractors that accept error message args John W. Eaton <jwe@octave.org> parents: 20652 diff changeset	7519 std::string tmp = args(1).xstring_value ("issorted: second argument must be a string");
20582 ba2b07c13913 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20574 diff changeset	7520 if (tmp == "rows")
ba2b07c13913 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20574 diff changeset	7521 by_rows = true;
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7522 else
20720 7c21b151b8b4 build: Fix warning messages from compiler. Rik <rik@octave.org> parents: 20711 diff changeset	7523 smode = get_sort_mode_option (args(1));
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7524 }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	7525
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	7526 octave_value retval;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	7527
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7528 octave_value arg = args(0);
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7529
25850 153495e05477 issorted: return true on an empty array (bug #54599) Mike Miller <mtmiller@octave.org> parents: 25646 diff changeset	7530 if (arg.isempty ())
153495e05477 issorted: return true on an empty array (bug #54599) Mike Miller <mtmiller@octave.org> parents: 25646 diff changeset	7531 retval = true;
153495e05477 issorted: return true on an empty array (bug #54599) Mike Miller <mtmiller@octave.org> parents: 25646 diff changeset	7532 else if (by_rows)
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7533 {
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	7534 if (arg.issparse ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	7535 error ("issorted: sparse matrices not yet supported");
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	7536
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	7537 if (arg.ndims () != 2)
21014 b9d4c3615e89 maint: Capitalize D for dimension in messages and comments. Rik <rik@octave.org> parents: 20980 diff changeset	7538 error ("issorted: A must be a 2-D object");
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	7539
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	7540 retval = arg.is_sorted_rows (smode) != UNSORTED;
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7541 }
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7542 else
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7543 {
23592 80e3bfb7bd5a maint: Deprecate is_vector and replace with isvector. Rik <rik@octave.org> parents: 23588 diff changeset	7544 if (! arg.dims ().isvector ())
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7545 error ("issorted: needs a vector");
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	7546
23588 0549061d35b9 maint: Deprecate is_sorted and replace with issorted. Rik <rik@octave.org> parents: 23587 diff changeset	7547 retval = args(0).issorted (smode) != UNSORTED;
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7548 }
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7549
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7550 return retval;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7551 }
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7552
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7553 /*
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7554 %!shared sm, um, sv, uv
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7555 %! sm = [1, 2; 3, 4];
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7556 %! um = [3, 1; 2, 4];
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7557 %! sv = [1, 2, 3, 4];
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7558 %! uv = [2, 1, 4, 3];
20809 9e9892519a7c Add more BIST tests for issorted. Rik <rik@octave.org> parents: 20806 diff changeset	7559
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7560 %!assert (issorted (sm, "rows"))
20809 9e9892519a7c Add more BIST tests for issorted. Rik <rik@octave.org> parents: 20806 diff changeset	7561 %!assert (! issorted (um, "rows"))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7562 %!assert (issorted (sv))
20809 9e9892519a7c Add more BIST tests for issorted. Rik <rik@octave.org> parents: 20806 diff changeset	7563 %!assert (! issorted (uv))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7564 %!assert (issorted (sv'))
20809 9e9892519a7c Add more BIST tests for issorted. Rik <rik@octave.org> parents: 20806 diff changeset	7565 %!assert (! issorted (uv'))
25484 b7db401e1a99 Use "ascend"/"descend" for issorted direction (bug #54147). Rik <rik@octave.org> parents: 25473 diff changeset	7566 %!assert (issorted (sm, "rows", "ascend"))
b7db401e1a99 Use "ascend"/"descend" for issorted direction (bug #54147). Rik <rik@octave.org> parents: 25473 diff changeset	7567 %!assert (! issorted (um, "rows", "ascend"))
b7db401e1a99 Use "ascend"/"descend" for issorted direction (bug #54147). Rik <rik@octave.org> parents: 25473 diff changeset	7568 %!assert (issorted (sv, "ascend"))
b7db401e1a99 Use "ascend"/"descend" for issorted direction (bug #54147). Rik <rik@octave.org> parents: 25473 diff changeset	7569 %!assert (! issorted (uv, "ascend"))
b7db401e1a99 Use "ascend"/"descend" for issorted direction (bug #54147). Rik <rik@octave.org> parents: 25473 diff changeset	7570 %!assert (issorted (sv', "ascend"))
b7db401e1a99 Use "ascend"/"descend" for issorted direction (bug #54147). Rik <rik@octave.org> parents: 25473 diff changeset	7571 %!assert (! issorted (uv', "ascend"))
b7db401e1a99 Use "ascend"/"descend" for issorted direction (bug #54147). Rik <rik@octave.org> parents: 25473 diff changeset	7572 %!assert (! issorted (sm, "rows", "descend"))
b7db401e1a99 Use "ascend"/"descend" for issorted direction (bug #54147). Rik <rik@octave.org> parents: 25473 diff changeset	7573 %!assert (issorted (flipud (sm), "rows", "descend"))
b7db401e1a99 Use "ascend"/"descend" for issorted direction (bug #54147). Rik <rik@octave.org> parents: 25473 diff changeset	7574 %!assert (! issorted (sv, "descend"))
b7db401e1a99 Use "ascend"/"descend" for issorted direction (bug #54147). Rik <rik@octave.org> parents: 25473 diff changeset	7575 %!assert (issorted (fliplr (sv), "descend"))
b7db401e1a99 Use "ascend"/"descend" for issorted direction (bug #54147). Rik <rik@octave.org> parents: 25473 diff changeset	7576 %!assert (! issorted (sv', "descend"))
b7db401e1a99 Use "ascend"/"descend" for issorted direction (bug #54147). Rik <rik@octave.org> parents: 25473 diff changeset	7577 %!assert (issorted (fliplr (sv)', "descend"))
20809 9e9892519a7c Add more BIST tests for issorted. Rik <rik@octave.org> parents: 20806 diff changeset	7578 %!assert (! issorted (um, "rows", "either"))
9e9892519a7c Add more BIST tests for issorted. Rik <rik@octave.org> parents: 20806 diff changeset	7579 %!assert (! issorted (uv, "either"))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7580 %!assert (issorted (sm, "rows", "either"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7581 %!assert (issorted (flipud (sm), "rows", "either"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7582 %!assert (issorted (sv, "either"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7583 %!assert (issorted (fliplr (sv), "either"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7584 %!assert (issorted (sv', "either"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7585 %!assert (issorted (fliplr (sv)', "either"))
20809 9e9892519a7c Add more BIST tests for issorted. Rik <rik@octave.org> parents: 20806 diff changeset	7586
25850 153495e05477 issorted: return true on an empty array (bug #54599) Mike Miller <mtmiller@octave.org> parents: 25646 diff changeset	7587 %!assert (issorted ([]))
153495e05477 issorted: return true on an empty array (bug #54599) Mike Miller <mtmiller@octave.org> parents: 25646 diff changeset	7588 %!assert (issorted ([], "rows"))
153495e05477 issorted: return true on an empty array (bug #54599) Mike Miller <mtmiller@octave.org> parents: 25646 diff changeset	7589 %!assert (issorted ([], "ascend"))
153495e05477 issorted: return true on an empty array (bug #54599) Mike Miller <mtmiller@octave.org> parents: 25646 diff changeset	7590 %!assert (issorted ([], "rows", "ascend"))
153495e05477 issorted: return true on an empty array (bug #54599) Mike Miller <mtmiller@octave.org> parents: 25646 diff changeset	7591 %!assert (issorted ([], "descend"))
153495e05477 issorted: return true on an empty array (bug #54599) Mike Miller <mtmiller@octave.org> parents: 25646 diff changeset	7592 %!assert (issorted ([], "rows", "descend"))
153495e05477 issorted: return true on an empty array (bug #54599) Mike Miller <mtmiller@octave.org> parents: 25646 diff changeset	7593 %!assert (issorted ({}))
153495e05477 issorted: return true on an empty array (bug #54599) Mike Miller <mtmiller@octave.org> parents: 25646 diff changeset	7594 %!assert (issorted ({}, "rows"))
153495e05477 issorted: return true on an empty array (bug #54599) Mike Miller <mtmiller@octave.org> parents: 25646 diff changeset	7595 %!assert (issorted ({}, "ascend"))
153495e05477 issorted: return true on an empty array (bug #54599) Mike Miller <mtmiller@octave.org> parents: 25646 diff changeset	7596 %!assert (issorted ({}, "rows", "ascend"))
153495e05477 issorted: return true on an empty array (bug #54599) Mike Miller <mtmiller@octave.org> parents: 25646 diff changeset	7597 %!assert (issorted ({}, "descend"))
153495e05477 issorted: return true on an empty array (bug #54599) Mike Miller <mtmiller@octave.org> parents: 25646 diff changeset	7598 %!assert (issorted ({}, "rows", "descend"))
153495e05477 issorted: return true on an empty array (bug #54599) Mike Miller <mtmiller@octave.org> parents: 25646 diff changeset	7599 %!assert (issorted (""))
153495e05477 issorted: return true on an empty array (bug #54599) Mike Miller <mtmiller@octave.org> parents: 25646 diff changeset	7600 %!assert (issorted ("", "rows"))
153495e05477 issorted: return true on an empty array (bug #54599) Mike Miller <mtmiller@octave.org> parents: 25646 diff changeset	7601 %!assert (issorted ("", "ascend"))
153495e05477 issorted: return true on an empty array (bug #54599) Mike Miller <mtmiller@octave.org> parents: 25646 diff changeset	7602 %!assert (issorted ("", "rows", "ascend"))
153495e05477 issorted: return true on an empty array (bug #54599) Mike Miller <mtmiller@octave.org> parents: 25646 diff changeset	7603 %!assert (issorted ("", "descend"))
153495e05477 issorted: return true on an empty array (bug #54599) Mike Miller <mtmiller@octave.org> parents: 25646 diff changeset	7604 %!assert (issorted ("", "rows", "descend"))
20809 9e9892519a7c Add more BIST tests for issorted. Rik <rik@octave.org> parents: 20806 diff changeset	7605
9e9892519a7c Add more BIST tests for issorted. Rik <rik@octave.org> parents: 20806 diff changeset	7606 ## Test input validation
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20853 diff changeset	7607 %!error issorted ()
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20853 diff changeset	7608 %!error issorted (1,2,3,4)
20809 9e9892519a7c Add more BIST tests for issorted. Rik <rik@octave.org> parents: 20806 diff changeset	7609 %!error <second argument must be a string> issorted (1, 2)
9e9892519a7c Add more BIST tests for issorted. Rik <rik@octave.org> parents: 20806 diff changeset	7610 %!error <second argument must be a string> issorted (1, {"rows"})
9e9892519a7c Add more BIST tests for issorted. Rik <rik@octave.org> parents: 20806 diff changeset	7611 %!error <sparse matrices not yet supported> issorted (sparse ([1 2 3]), "rows")
21014 b9d4c3615e89 maint: Capitalize D for dimension in messages and comments. Rik <rik@octave.org> parents: 20980 diff changeset	7612 %!error <A must be a 2-D object> issorted (rand (2,2,2), "rows")
20809 9e9892519a7c Add more BIST tests for issorted. Rik <rik@octave.org> parents: 20806 diff changeset	7613 %!error <needs a vector> issorted (ones (2,2))
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7614 */
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7615
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7616 DEFUN (nth_element, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7617 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	7618 @deftypefn {} {@var{nel} =} nth_element (@var{x}, @var{n})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	7619 @deftypefnx {} {@var{nel} =} nth_element (@var{x}, @var{n}, @var{dim})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7620 Select the n-th smallest element of a vector, using the ordering defined by
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7621 @code{sort}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7622
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7623 The result is equivalent to @code{sort(@var{x})(@var{n})}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7624
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7625 @var{n} can also be a contiguous range, either ascending @code{l:u}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7626 or descending @code{u:-1:l}, in which case a range of elements is returned.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7627
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7628 If @var{x} is an array, @code{nth_element} operates along the dimension
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7629 defined by @var{dim}, or the first non-singleton dimension if @var{dim} is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7630 not given.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7631
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7632 Programming Note: nth_element encapsulates the C++ standard library
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7633 algorithms nth_element and partial_sort. On average, the complexity of the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7634 operation is O(M*log(K)), where @w{@code{M = size (@var{x}, @var{dim})}} and
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7635 @w{@code{K = length (@var{n})}}. This function is intended for cases where
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7636 the ratio K/M is small; otherwise, it may be better to use @code{sort}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7637 @seealso{sort, min, max}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7638 @end deftypefn */)
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7639 {
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7640 int nargin = args.length ();
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7641
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7642 if (nargin < 2 \|\| nargin > 3)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7643 print_usage ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7644
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7645 int dim = -1;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7646 if (nargin == 3)
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7647 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7648 dim = args(2).int_value (true) - 1;
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7649 if (dim < 0)
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7650 error ("nth_element: DIM must be a valid dimension");
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7651 }
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	7652
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	7653 octave_value argx = args(0);
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7654 if (dim < 0)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7655 dim = argx.dims ().first_non_singleton ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7656
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	7657 octave_value retval;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	7658
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7659 try
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7660 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	7661 idx_vector n = args(1).index_vector ();
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7662
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7663 switch (argx.builtin_type ())
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7664 {
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7665 case btyp_double:
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7666 retval = argx.array_value ().nth_element (n, dim);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7667 break;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7668 case btyp_float:
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7669 retval = argx.float_array_value ().nth_element (n, dim);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7670 break;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7671 case btyp_complex:
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7672 retval = argx.complex_array_value ().nth_element (n, dim);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7673 break;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7674 case btyp_float_complex:
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7675 retval = argx.float_complex_array_value ().nth_element (n, dim);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7676 break;
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	7677
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	7678 #define MAKE_INT_BRANCH(X) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	7679 case btyp_ ## X: \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	7680 retval = argx.X ## _array_value ().nth_element (n, dim); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	7681 break;
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7682
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7683 MAKE_INT_BRANCH (int8);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7684 MAKE_INT_BRANCH (int16);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7685 MAKE_INT_BRANCH (int32);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7686 MAKE_INT_BRANCH (int64);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7687 MAKE_INT_BRANCH (uint8);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7688 MAKE_INT_BRANCH (uint16);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7689 MAKE_INT_BRANCH (uint32);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7690 MAKE_INT_BRANCH (uint64);
21540 ffb4770ba079 Make median preserve discrete types (bug #47515). Lachlan Andrew <lachlanbis@gmail.com> parents: 21458 diff changeset	7691 MAKE_INT_BRANCH (bool);
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	7692
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7693 #undef MAKE_INT_BRANCH
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	7694
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7695 default:
23575 e95738a119da maint: Deprecate is_cellstr and replace with iscellstr. Rik <rik@octave.org> parents: 23573 diff changeset	7696 if (argx.iscellstr ())
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7697 retval = argx.cellstr_value ().nth_element (n, dim);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7698 else
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21078 diff changeset	7699 err_wrong_type_arg ("nth_element", argx);
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7700 }
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7701 }
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	7702 catch (const index_exception& ie)
29163 8f67ad8b3103 maint: Updating naming conventions for exceptions and use const where possible. Rik <rik@octave.org> parents: 29117 diff changeset	7703 {
8f67ad8b3103 maint: Updating naming conventions for exceptions and use const where possible. Rik <rik@octave.org> parents: 29117 diff changeset	7704 error ("nth_element: invalid index %s", ie.what ());
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7705 }
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7706
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7707 return retval;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7708 }
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7709
23734 3e93a2a66cdf nth_element: allow sequence of indices to be passed as a vector (bug #51329) Brad Kennedy <bk@co60.ca> parents: 23693 diff changeset	7710 /*
3e93a2a66cdf nth_element: allow sequence of indices to be passed as a vector (bug #51329) Brad Kennedy <bk@co60.ca> parents: 23693 diff changeset	7711 %!assert (nth_element ([1:10], 1), 1)
3e93a2a66cdf nth_element: allow sequence of indices to be passed as a vector (bug #51329) Brad Kennedy <bk@co60.ca> parents: 23693 diff changeset	7712 %!assert (nth_element ([1:10], 10), 10)
3e93a2a66cdf nth_element: allow sequence of indices to be passed as a vector (bug #51329) Brad Kennedy <bk@co60.ca> parents: 23693 diff changeset	7713 %!assert (nth_element ([1:10], 1:3), [1 2 3])
3e93a2a66cdf nth_element: allow sequence of indices to be passed as a vector (bug #51329) Brad Kennedy <bk@co60.ca> parents: 23693 diff changeset	7714 %!assert (nth_element ([1:10], 1:10), [1:10])
3e93a2a66cdf nth_element: allow sequence of indices to be passed as a vector (bug #51329) Brad Kennedy <bk@co60.ca> parents: 23693 diff changeset	7715
3e93a2a66cdf nth_element: allow sequence of indices to be passed as a vector (bug #51329) Brad Kennedy <bk@co60.ca> parents: 23693 diff changeset	7716 %!assert <*51329> (nth_element ([1:10], [1:10]), [1:10])
3e93a2a66cdf nth_element: allow sequence of indices to be passed as a vector (bug #51329) Brad Kennedy <bk@co60.ca> parents: 23693 diff changeset	7717
3e93a2a66cdf nth_element: allow sequence of indices to be passed as a vector (bug #51329) Brad Kennedy <bk@co60.ca> parents: 23693 diff changeset	7718 %!error nth_element ()
3e93a2a66cdf nth_element: allow sequence of indices to be passed as a vector (bug #51329) Brad Kennedy <bk@co60.ca> parents: 23693 diff changeset	7719 %!error nth_element (1)
3e93a2a66cdf nth_element: allow sequence of indices to be passed as a vector (bug #51329) Brad Kennedy <bk@co60.ca> parents: 23693 diff changeset	7720 %!error nth_element (1, 1.5)
3e93a2a66cdf nth_element: allow sequence of indices to be passed as a vector (bug #51329) Brad Kennedy <bk@co60.ca> parents: 23693 diff changeset	7721 %!error nth_element (1, 2, 3, 4)
3e93a2a66cdf nth_element: allow sequence of indices to be passed as a vector (bug #51329) Brad Kennedy <bk@co60.ca> parents: 23693 diff changeset	7722 %!error nth_element ("abcd", 3)
3e93a2a66cdf nth_element: allow sequence of indices to be passed as a vector (bug #51329) Brad Kennedy <bk@co60.ca> parents: 23693 diff changeset	7723 */
3e93a2a66cdf nth_element: allow sequence of indices to be passed as a vector (bug #51329) Brad Kennedy <bk@co60.ca> parents: 23693 diff changeset	7724
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21129 diff changeset	7725 template <typename NDT>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	7726 static NDT
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	7727 do_accumarray_sum (const idx_vector& idx, const NDT& vals,
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7728 octave_idx_type n = -1)
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7729 {
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7730 typedef typename NDT::element_type T;
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7731 if (n < 0)
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7732 n = idx.extent (0);
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7733 else if (idx.extent (n) > n)
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7734 error ("accumarray: index out of range");
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7735
14846 460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists. Rik <octave@nomad.inbox5.com> parents: 14843 diff changeset	7736 NDT retval (dim_vector (n, 1), T ());
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7737
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7738 if (vals.numel () == 1)
9858 47c5af1868df move idx_add methods to MArrayN Jaroslav Hajek <highegg@gmail.com> parents: 9856 diff changeset	7739 retval.idx_add (idx, vals (0));
47c5af1868df move idx_add methods to MArrayN Jaroslav Hajek <highegg@gmail.com> parents: 9856 diff changeset	7740 else if (vals.numel () == idx.length (n))
47c5af1868df move idx_add methods to MArrayN Jaroslav Hajek <highegg@gmail.com> parents: 9856 diff changeset	7741 retval.idx_add (idx, vals);
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7742 else
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7743 error ("accumarray: dimensions mismatch");
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7744
9858 47c5af1868df move idx_add methods to MArrayN Jaroslav Hajek <highegg@gmail.com> parents: 9856 diff changeset	7745 return retval;
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7746 }
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7747
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7748 DEFUN (__accumarray_sum__, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7749 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7750 @deftypefn {} {} __accumarray_sum__ (@var{idx}, @var{vals}, @var{n})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7751 Undocumented internal function.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7752 @end deftypefn */)
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7753 {
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7754 int nargin = args.length ();
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7755
22789 bedfedcd878e norm: fix error in input argument validation leading to segfault (bug #49634) Mike Miller <mtmiller@octave.org> parents: 22749 diff changeset	7756 if (nargin < 2 \|\| nargin > 3)
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7757 print_usage ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7758
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23585 diff changeset	7759 if (! args(0).isnumeric ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7760 error ("__accumarray_sum__: first argument must be numeric");
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7761
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7762 octave_value retval;
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	7763
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7764 try
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7765 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	7766 idx_vector idx = args(0).index_vector ();
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7767 octave_idx_type n = -1;
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7768 if (nargin == 3)
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7769 n = args(2).idx_type_value (true);
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7770
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7771 octave_value vals = args(1);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7772
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7773 if (vals.is_range ())
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7774 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	7775 range<double> r = vals.range_value ();
28636 a3db48e66ef8 use Range::increment instead of Range::inc John W. Eaton <jwe@octave.org> parents: 28631 diff changeset	7776 if (r.increment () == 0)
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7777 vals = r.base ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7778 }
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7779
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7780 if (vals.is_single_type ())
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7781 {
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	7782 if (vals.iscomplex ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7783 retval = do_accumarray_sum (idx,
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7784 vals.float_complex_array_value (),
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7785 n);
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7786 else
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7787 retval = do_accumarray_sum (idx, vals.float_array_value (), n);
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7788 }
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23585 diff changeset	7789 else if (vals.isnumeric () \|\| vals.islogical ())
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	7790 {
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	7791 if (vals.iscomplex ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7792 retval = do_accumarray_sum (idx,
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7793 vals.complex_array_value (),
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7794 n);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7795 else
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7796 retval = do_accumarray_sum (idx, vals.array_value (), n);
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	7797 }
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7798 else
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21078 diff changeset	7799 err_wrong_type_arg ("accumarray", vals);
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7800 }
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	7801 catch (const index_exception& ie)
29163 8f67ad8b3103 maint: Updating naming conventions for exceptions and use const where possible. Rik <rik@octave.org> parents: 29117 diff changeset	7802 {
8f67ad8b3103 maint: Updating naming conventions for exceptions and use const where possible. Rik <rik@octave.org> parents: 29117 diff changeset	7803 error ("__accumarray_sum__: invalid index %s", ie.what ());
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7804 }
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7805
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	7806 return retval;
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7807 }
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7808
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21129 diff changeset	7809 template <typename NDT>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	7810 static NDT
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	7811 do_accumarray_minmax (const idx_vector& idx, const NDT& vals,
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7812 octave_idx_type n, bool ismin,
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7813 const typename NDT::element_type& zero_val)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7814 {
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7815 typedef typename NDT::element_type T;
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7816 if (n < 0)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7817 n = idx.extent (0);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7818 else if (idx.extent (n) > n)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7819 error ("accumarray: index out of range");
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7820
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7821 NDT retval (dim_vector (n, 1), zero_val);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7822
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7823 // Pick minimizer or maximizer.
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	7824 void (MArray<T>::*op) (const idx_vector&, const MArray<T>&)
27277 db687716fed6 style fixes: generally aim to break long lines before operators, not after John W. Eaton <jwe@octave.org> parents: 27081 diff changeset	7825 = ismin ? (&MArray<T>::idx_min) : (&MArray<T>::idx_max);
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7826
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7827 octave_idx_type l = idx.length (n);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7828 if (vals.numel () == 1)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7829 (retval.*op) (idx, NDT (dim_vector (l, 1), vals(0)));
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7830 else if (vals.numel () == l)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7831 (retval.*op) (idx, vals);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7832 else
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7833 error ("accumarray: dimensions mismatch");
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7834
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7835 return retval;
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7836 }
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7837
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7838 static octave_value_list
30896 c9788d7f6e65 maint: Use "fcn" as preferred abbreviation for "function" in libinterp/. Rik <rik@octave.org> parents: 30892 diff changeset	7839 do_accumarray_minmax_fcn (const octave_value_list& args,
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7840 bool ismin)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7841 {
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7842 int nargin = args.length ();
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7843
22789 bedfedcd878e norm: fix error in input argument validation leading to segfault (bug #49634) Mike Miller <mtmiller@octave.org> parents: 22749 diff changeset	7844 if (nargin < 3 \|\| nargin > 4)
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7845 print_usage ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7846
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23585 diff changeset	7847 if (! args(0).isnumeric ())
20811 5979314bb15a Fix BIST tests for rows. Rik <rik@octave.org> parents: 20810 diff changeset	7848 error ("accumarray: first argument must be numeric");
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7849
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7850 octave_value retval;
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	7851
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7852 try
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7853 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	7854 idx_vector idx = args(0).index_vector ();
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7855 octave_idx_type n = -1;
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7856 if (nargin == 4)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7857 n = args(3).idx_type_value (true);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7858
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7859 octave_value vals = args(1);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7860 octave_value zero = args(2);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7861
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7862 switch (vals.builtin_type ())
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7863 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7864 case btyp_double:
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7865 retval = do_accumarray_minmax (idx, vals.array_value (), n, ismin,
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7866 zero.double_value ());
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7867 break;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7868
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7869 case btyp_float:
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7870 retval = do_accumarray_minmax (idx, vals.float_array_value (), n,
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7871 ismin, zero.float_value ());
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7872 break;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7873
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7874 case btyp_complex:
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7875 retval = do_accumarray_minmax (idx, vals.complex_array_value (),
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7876 n, ismin, zero.complex_value ());
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7877 break;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7878
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7879 case btyp_float_complex:
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7880 retval = do_accumarray_minmax (idx,
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7881 vals.float_complex_array_value (),
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7882 n, ismin,
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7883 zero.float_complex_value ());
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7884 break;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7885
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	7886 #define MAKE_INT_BRANCH(X) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	7887 case btyp_ ## X: \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	7888 retval = do_accumarray_minmax (idx, vals.X ## _array_value (), \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	7889 n, ismin, zero.X ## _scalar_value ()); \
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7890 break;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7891
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7892 MAKE_INT_BRANCH (int8);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7893 MAKE_INT_BRANCH (int16);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7894 MAKE_INT_BRANCH (int32);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7895 MAKE_INT_BRANCH (int64);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7896 MAKE_INT_BRANCH (uint8);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7897 MAKE_INT_BRANCH (uint16);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7898 MAKE_INT_BRANCH (uint32);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7899 MAKE_INT_BRANCH (uint64);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7900
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7901 #undef MAKE_INT_BRANCH
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7902
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7903 case btyp_bool:
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7904 retval = do_accumarray_minmax (idx, vals.array_value (), n, ismin,
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7905 zero.bool_value ());
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7906 break;
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7907
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7908 default:
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21078 diff changeset	7909 err_wrong_type_arg ("accumarray", vals);
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7910 }
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7911 }
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	7912 catch (const index_exception& ie)
29163 8f67ad8b3103 maint: Updating naming conventions for exceptions and use const where possible. Rik <rik@octave.org> parents: 29117 diff changeset	7913 {
30896 c9788d7f6e65 maint: Use "fcn" as preferred abbreviation for "function" in libinterp/. Rik <rik@octave.org> parents: 30892 diff changeset	7914 error ("do_accumarray_minmax_fcn: invalid index %s", ie.what ());
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7915 }
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7916
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	7917 return retval;
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7918 }
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7919
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7920 DEFUN (__accumarray_min__, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7921 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7922 @deftypefn {} {} __accumarray_min__ (@var{idx}, @var{vals}, @var{zero}, @var{n})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7923 Undocumented internal function.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7924 @end deftypefn */)
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7925 {
30896 c9788d7f6e65 maint: Use "fcn" as preferred abbreviation for "function" in libinterp/. Rik <rik@octave.org> parents: 30892 diff changeset	7926 return do_accumarray_minmax_fcn (args, true);
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7927 }
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7928
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7929 DEFUN (__accumarray_max__, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7930 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7931 @deftypefn {} {} __accumarray_max__ (@var{idx}, @var{vals}, @var{zero}, @var{n})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7932 Undocumented internal function.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7933 @end deftypefn */)
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7934 {
30896 c9788d7f6e65 maint: Use "fcn" as preferred abbreviation for "function" in libinterp/. Rik <rik@octave.org> parents: 30892 diff changeset	7935 return do_accumarray_minmax_fcn (args, false);
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7936 }
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7937
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21129 diff changeset	7938 template <typename NDT>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	7939 static NDT
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	7940 do_accumdim_sum (const idx_vector& idx, const NDT& vals,
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7941 int dim = -1, octave_idx_type n = -1)
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7942 {
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7943 typedef typename NDT::element_type T;
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7944 if (n < 0)
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7945 n = idx.extent (0);
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7946 else if (idx.extent (n) > n)
14113 dac62c415e8b Do more error checking on accumarray and accumdim input. Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14100 diff changeset	7947 error ("accumdim: index out of range");
dac62c415e8b Do more error checking on accumarray and accumdim input. Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14100 diff changeset	7948
32598 2f3b54f81947 avoid dim_vector copies in more places where possible (bug #64962) John W. Eaton <jwe@octave.org> parents: 32585 diff changeset	7949 const dim_vector& vals_dim = vals.dims ();
18100 6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	7950 dim_vector rdv = vals_dim;
14113 dac62c415e8b Do more error checking on accumarray and accumdim input. Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14100 diff changeset	7951
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7952 if (dim < 0)
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7953 dim = vals.dims ().first_non_singleton ();
21660 53728df3e4c9 maint: for clarity, call ndims() rather than length() on dimension vectors. Rik <rik@octave.org> parents: 21602 diff changeset	7954 else if (dim >= rdv.ndims ())
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7955 rdv.resize (dim+1, 1);
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7956
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7957 rdv(dim) = n;
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7958
14846 460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists. Rik <octave@nomad.inbox5.com> parents: 14843 diff changeset	7959 NDT retval (rdv, T ());
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7960
14113 dac62c415e8b Do more error checking on accumarray and accumdim input. Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14100 diff changeset	7961 if (idx.length () != vals_dim(dim))
dac62c415e8b Do more error checking on accumarray and accumdim input. Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14100 diff changeset	7962 error ("accumdim: dimension mismatch");
dac62c415e8b Do more error checking on accumarray and accumdim input. Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14100 diff changeset	7963
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7964 retval.idx_add_nd (idx, vals, dim);
14113 dac62c415e8b Do more error checking on accumarray and accumdim input. Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14100 diff changeset	7965
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7966 return retval;
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7967 }
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7968
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7969 DEFUN (__accumdim_sum__, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7970 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7971 @deftypefn {} {} __accumdim_sum__ (@var{idx}, @var{vals}, @var{dim}, @var{n})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7972 Undocumented internal function.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	7973 @end deftypefn */)
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7974 {
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7975 int nargin = args.length ();
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7976
22789 bedfedcd878e norm: fix error in input argument validation leading to segfault (bug #49634) Mike Miller <mtmiller@octave.org> parents: 22749 diff changeset	7977 if (nargin < 2 \|\| nargin > 4)
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7978 print_usage ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7979
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23585 diff changeset	7980 if (! args(0).isnumeric ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7981 error ("__accumdim_sum__: first argument must be numeric");
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7982
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7983 octave_value retval;
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	7984
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7985 try
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7986 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	7987 idx_vector idx = args(0).index_vector ();
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7988 int dim = -1;
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7989 if (nargin >= 3)
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7990 dim = args(2).int_value () - 1;
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7991
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7992 octave_idx_type n = -1;
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7993 if (nargin == 4)
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7994 n = args(3).idx_type_value (true);
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7995
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7996 octave_value vals = args(1);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7997
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	7998 if (vals.is_single_type ())
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7999 {
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	8000 if (vals.iscomplex ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8001 retval = do_accumdim_sum (idx,
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8002 vals.float_complex_array_value (),
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8003 dim, n);
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	8004 else
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8005 retval = do_accumdim_sum (idx, vals.float_array_value (),
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8006 dim, n);
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	8007 }
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23585 diff changeset	8008 else if (vals.isnumeric () \|\| vals.islogical ())
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	8009 {
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	8010 if (vals.iscomplex ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8011 retval = do_accumdim_sum (idx, vals.complex_array_value (),
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8012 dim, n);
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	8013 else
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8014 retval = do_accumdim_sum (idx, vals.array_value (), dim, n);
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	8015 }
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8016 else
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21078 diff changeset	8017 err_wrong_type_arg ("accumdim", vals);
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	8018 }
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	8019 catch (const index_exception& ie)
29163 8f67ad8b3103 maint: Updating naming conventions for exceptions and use const where possible. Rik <rik@octave.org> parents: 29117 diff changeset	8020 {
8f67ad8b3103 maint: Updating naming conventions for exceptions and use const where possible. Rik <rik@octave.org> parents: 29117 diff changeset	8021 error ("__accumdim_sum__: invalid index %s", ie.what ());
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8022 }
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	8023
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	8024 return retval;
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	8025 }
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	8026
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21129 diff changeset	8027 template <typename NDT>
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8028 static NDT
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8029 do_merge (const Array<bool>& mask,
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8030 const NDT& tval, const NDT& fval)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8031 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8032 typedef typename NDT::element_type T;
32598 2f3b54f81947 avoid dim_vector copies in more places where possible (bug #64962) John W. Eaton <jwe@octave.org> parents: 32585 diff changeset	8033 const dim_vector& dv = mask.dims ();
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8034 NDT retval (dv);
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8035
18100 6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	8036 bool tscl = tval.numel () == 1;
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	8037 bool fscl = fval.numel () == 1;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	8038
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8039 if ((! tscl && tval.dims () != dv) \|\| (! fscl && fval.dims () != dv))
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	8040 error ("merge: MASK, TVAL, and FVAL dimensions must match");
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8041
32660 f53ac65ffba6 maint: New method rwdata() as clearer alternative to fortran_vec(). Rik <rik@octave.org> parents: 32633 diff changeset	8042 T *rv = retval.rwdata ();
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8043 octave_idx_type n = retval.numel ();
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8044
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8045 const T *tv = tval.data ();
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8046 const T *fv = fval.data ();
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8047 const bool *mv = mask.data ();
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8048
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8049 if (tscl)
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8050 {
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8051 if (fscl)
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8052 {
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8053 T ts = tv[0];
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8054 T fs = fv[0];
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8055 for (octave_idx_type i = 0; i < n; i++)
23450 855122b993da maint: Wrap tertiary operator in parentheses "(COND ? x : y)". Rik <rik@octave.org> parents: 23449 diff changeset	8056 rv[i] = (mv[i] ? ts : fs);
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8057 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8058 else
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8059 {
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8060 T ts = tv[0];
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8061 for (octave_idx_type i = 0; i < n; i++)
23450 855122b993da maint: Wrap tertiary operator in parentheses "(COND ? x : y)". Rik <rik@octave.org> parents: 23449 diff changeset	8062 rv[i] = (mv[i] ? ts : fv[i]);
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8063 }
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8064 }
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8065 else
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8066 {
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8067 if (fscl)
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8068 {
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8069 T fs = fv[0];
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8070 for (octave_idx_type i = 0; i < n; i++)
23450 855122b993da maint: Wrap tertiary operator in parentheses "(COND ? x : y)". Rik <rik@octave.org> parents: 23449 diff changeset	8071 rv[i] = (mv[i] ? tv[i] : fs);
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8072 }
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8073 else
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8074 {
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 21053 diff changeset	8075 for (octave_idx_type i = 0; i < n; i++)
23450 855122b993da maint: Wrap tertiary operator in parentheses "(COND ? x : y)". Rik <rik@octave.org> parents: 23449 diff changeset	8076 rv[i] = (mv[i] ? tv[i] : fv[i]);
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8077 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8078 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8079
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8080 return retval;
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8081 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8082
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	8083 #define MAKE_INT_BRANCH(INTX) \
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8084 else if (tval.is_ ## INTX ## _type () && fval.is_ ## INTX ## _type ()) \
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	8085 { \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	8086 retval = do_merge (mask, \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	8087 tval.INTX ## _array_value (), \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	8088 fval.INTX ## _array_value ()); \
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8089 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8090
9505 a321a1c227c8 make ifelse an alias or merge Jaroslav Hajek <highegg@gmail.com> parents: 9475 diff changeset	8091 DEFUN (merge, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8092 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	8093 @deftypefn {} {@var{M} =} merge (@var{mask}, @var{tval}, @var{fval})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	8094 @deftypefnx {} {@var{M} =} ifelse (@var{mask}, @var{tval}, @var{fval})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8095 Merge elements of @var{true_val} and @var{false_val}, depending on the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8096 value of @var{mask}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8097
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8098 If @var{mask} is a logical scalar, the other two arguments can be arbitrary
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8099 values. Otherwise, @var{mask} must be a logical array, and @var{tval},
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8100 @var{fval} should be arrays of matching class, or cell arrays. In the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8101 scalar mask case, @var{tval} is returned if @var{mask} is true, otherwise
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8102 @var{fval} is returned.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8103
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8104 In the array mask case, both @var{tval} and @var{fval} must be either
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8105 scalars or arrays with dimensions equal to @var{mask}. The result is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8106 constructed as follows:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8107
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8108 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8109 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8110 result(mask) = tval(mask);
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8111 result(! mask) = fval(! mask);
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8112 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8113 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8114
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8115 @var{mask} can also be arbitrary numeric type, in which case it is first
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8116 converted to logical.
32581 ca5d00ab014c Apply consistent notes in docstrings for aliased functions Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32513 diff changeset	8117
ca5d00ab014c Apply consistent notes in docstrings for aliased functions Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32513 diff changeset	8118 Programming Note: @code{ifelse} is an alias for @code{merge} and can be used
ca5d00ab014c Apply consistent notes in docstrings for aliased functions Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32513 diff changeset	8119 interchangeably.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8120 @seealso{logical, diff}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8121 @end deftypefn */)
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8122 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8123 if (args.length () != 3)
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8124 print_usage ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8125
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23585 diff changeset	8126 if (! (args(0).islogical () \|\| args(0).isnumeric ()))
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8127 error ("merge: first argument must be logical or numeric");
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8128
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8129 octave_value retval;
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8130
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8131 octave_value mask_val = args(0);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8132
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8133 if (mask_val.is_scalar_type ())
23450 855122b993da maint: Wrap tertiary operator in parentheses "(COND ? x : y)". Rik <rik@octave.org> parents: 23449 diff changeset	8134 retval = (mask_val.is_true () ? args(1) : args(2));
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8135 else
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8136 {
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8137 boolNDArray mask = mask_val.bool_array_value ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8138
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8139 octave_value tval = args(1);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8140 octave_value fval = args(2);
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8141
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8142 if (tval.is_double_type () && fval.is_double_type ())
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8143 {
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	8144 if (tval.iscomplex () \|\| fval.iscomplex ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8145 retval = do_merge (mask,
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8146 tval.complex_array_value (),
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8147 fval.complex_array_value ());
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8148 else
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8149 retval = do_merge (mask,
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8150 tval.array_value (),
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8151 fval.array_value ());
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8152 }
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8153 else if (tval.is_single_type () && fval.is_single_type ())
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8154 {
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	8155 if (tval.iscomplex () \|\| fval.iscomplex ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8156 retval = do_merge (mask,
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8157 tval.float_complex_array_value (),
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8158 fval.float_complex_array_value ());
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8159 else
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8160 retval = do_merge (mask,
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8161 tval.float_array_value (),
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8162 fval.float_array_value ());
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8163 }
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8164 else if (tval.is_string () && fval.is_string ())
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8165 {
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8166 bool sq_string = tval.is_sq_string () \|\| fval.is_sq_string ();
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8167 retval = octave_value (do_merge (mask,
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8168 tval.char_array_value (),
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8169 fval.char_array_value ()),
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8170 sq_string ? '\'' : '"');
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8171 }
23576 00e518162fda maint: Deprecate is_cell and replace with iscell. Rik <rik@octave.org> parents: 23575 diff changeset	8172 else if (tval.iscell () && fval.iscell ())
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8173 {
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8174 retval = do_merge (mask,
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8175 tval.cell_value (),
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8176 fval.cell_value ());
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8177 }
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8178
22407 34ce5be04942 maint: Style check C++ code in libinterp/. Rik <rik@octave.org> parents: 22327 diff changeset	8179 MAKE_INT_BRANCH (int8)
34ce5be04942 maint: Style check C++ code in libinterp/. Rik <rik@octave.org> parents: 22327 diff changeset	8180 MAKE_INT_BRANCH (int16)
34ce5be04942 maint: Style check C++ code in libinterp/. Rik <rik@octave.org> parents: 22327 diff changeset	8181 MAKE_INT_BRANCH (int32)
34ce5be04942 maint: Style check C++ code in libinterp/. Rik <rik@octave.org> parents: 22327 diff changeset	8182 MAKE_INT_BRANCH (int64)
34ce5be04942 maint: Style check C++ code in libinterp/. Rik <rik@octave.org> parents: 22327 diff changeset	8183 MAKE_INT_BRANCH (uint8)
34ce5be04942 maint: Style check C++ code in libinterp/. Rik <rik@octave.org> parents: 22327 diff changeset	8184 MAKE_INT_BRANCH (uint16)
34ce5be04942 maint: Style check C++ code in libinterp/. Rik <rik@octave.org> parents: 22327 diff changeset	8185 MAKE_INT_BRANCH (uint32)
34ce5be04942 maint: Style check C++ code in libinterp/. Rik <rik@octave.org> parents: 22327 diff changeset	8186 MAKE_INT_BRANCH (uint64)
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8187
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8188 else
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8189 error ("merge: cannot merge %s with %s with array mask",
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8190 tval.class_name ().c_str (),
20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8191 fval.class_name ().c_str ());
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8192 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8193
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8194 return retval;
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8195 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8196
9505 a321a1c227c8 make ifelse an alias or merge Jaroslav Hajek <highegg@gmail.com> parents: 9475 diff changeset	8197 DEFALIAS (ifelse, merge);
a321a1c227c8 make ifelse an alias or merge Jaroslav Hajek <highegg@gmail.com> parents: 9475 diff changeset	8198
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	8199 #undef MAKE_INT_BRANCH
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	8200
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21129 diff changeset	8201 template <typename SparseT>
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8202 static SparseT
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8203 do_sparse_diff (const SparseT& array, octave_idx_type order,
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8204 int dim)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8205 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8206 SparseT retval = array;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8207 if (dim == 1)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8208 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8209 octave_idx_type k = retval.columns ();
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8210 while (order > 0 && k > 0)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8211 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	8212 idx_vector col1 (':'), col2 (':'), sl1 (1, k), sl2 (0, k-1);
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8213 retval = SparseT (retval.index (col1, sl1))
22407 34ce5be04942 maint: Style check C++ code in libinterp/. Rik <rik@octave.org> parents: 22327 diff changeset	8214 - SparseT (retval.index (col2, sl2));
33250 40fde86be9b0 replace calls to error_* with corresponding panic_* functions in libinterp John W. Eaton <jwe@octave.org> parents: 33032 diff changeset	8215 panic_unless (retval.columns () == k-1);
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8216 order--;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8217 k--;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8218 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8219 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8220 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8221 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8222 octave_idx_type k = retval.rows ();
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8223 while (order > 0 && k > 0)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8224 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	8225 idx_vector col1 (':'), col2 (':'), sl1 (1, k), sl2 (0, k-1);
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8226 retval = SparseT (retval.index (sl1, col1))
22407 34ce5be04942 maint: Style check C++ code in libinterp/. Rik <rik@octave.org> parents: 22327 diff changeset	8227 - SparseT (retval.index (sl2, col2));
33250 40fde86be9b0 replace calls to error_* with corresponding panic_* functions in libinterp John W. Eaton <jwe@octave.org> parents: 33032 diff changeset	8228 panic_unless (retval.rows () == k-1);
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8229 order--;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8230 k--;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8231 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8232 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8233
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8234 return retval;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8235 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8236
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8237 static octave_value
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8238 do_diff (const octave_value& array, octave_idx_type order,
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8239 int dim = -1)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8240 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8241 octave_value retval;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8242
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8243 const dim_vector& dv = array.dims ();
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8244 if (dim == -1)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8245 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8246 dim = array.dims ().first_non_singleton ();
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8247
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21730 diff changeset	8248 // Bother Matlab. This behavior is really wicked.
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8249 if (dv(dim) <= order)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8250 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8251 if (dv(dim) == 1)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8252 retval = array.resize (dim_vector (0, 0));
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8253 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8254 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8255 retval = array;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8256 while (order > 0)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8257 {
21660 53728df3e4c9 maint: for clarity, call ndims() rather than length() on dimension vectors. Rik <rik@octave.org> parents: 21602 diff changeset	8258 if (dim == dv.ndims ())
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8259 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8260 retval = do_diff (array, order, dim - 1);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8261 order = 0;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8262 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8263 else if (dv(dim) == 1)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8264 dim++;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8265 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8266 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8267 retval = do_diff (array, dv(dim) - 1, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8268 order -= dv(dim) - 1;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8269 dim++;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8270 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8271 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8272 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8273
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8274 return retval;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8275 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8276 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8277
23580 2230f9e10fb3 maint: Deprecate is_integer_type and replace with isinteger. Rik <rik@octave.org> parents: 23579 diff changeset	8278 if (array.isinteger ())
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8279 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8280 if (array.is_int8_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8281 retval = array.int8_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8282 else if (array.is_int16_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8283 retval = array.int16_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8284 else if (array.is_int32_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8285 retval = array.int32_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8286 else if (array.is_int64_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8287 retval = array.int64_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8288 else if (array.is_uint8_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8289 retval = array.uint8_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8290 else if (array.is_uint16_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8291 retval = array.uint16_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8292 else if (array.is_uint32_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8293 retval = array.uint32_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8294 else if (array.is_uint64_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8295 retval = array.uint64_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8296 else
33382 79cfa1b7a813 replace nearly all remaining uses of panic_impossible with error John W. Eaton <jwe@octave.org> parents: 33365 diff changeset	8297 error ("diff: unexpected integer type - please report this bug");
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8298 }
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	8299 else if (array.issparse ())
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8300 {
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	8301 if (array.iscomplex ())
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8302 retval = do_sparse_diff (array.sparse_complex_matrix_value (),
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8303 order, dim);
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8304 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8305 retval = do_sparse_diff (array.sparse_matrix_value (), order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8306 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8307 else if (array.is_single_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8308 {
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	8309 if (array.iscomplex ())
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8310 retval = array.float_complex_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8311 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8312 retval = array.float_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8313 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8314 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8315 {
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	8316 if (array.iscomplex ())
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8317 retval = array.complex_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8318 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8319 retval = array.array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8320 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8321
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8322 return retval;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8323 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8324
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8325 DEFUN (diff, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8326 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	8327 @deftypefn {} {@var{y} =} diff (@var{x})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	8328 @deftypefnx {} {@var{y} =} diff (@var{x}, @var{k})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	8329 @deftypefnx {} {@var{y} =} diff (@var{x}, @var{k}, @var{dim})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8330 If @var{x} is a vector of length @math{n}, @w{@code{diff (@var{x})}} is the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8331 vector of first differences
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8332 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8333 $x_2 - x_1, \ldots{}, x_n - x_{n-1}$.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8334 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8335 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8336 @var{x}(2) - @var{x}(1), @dots{}, @var{x}(n) - @var{x}(n-1).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8337 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8338
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8339 If @var{x} is a matrix, @w{@code{diff (@var{x})}} is the matrix of column
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8340 differences along the first non-singleton dimension.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8341
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8342 The second argument is optional. If supplied,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8343 @w{@code{diff (@var{x}, @var{k})}}, where @var{k} is a non-negative integer,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8344 returns the @var{k}-th differences. It is possible that @var{k} is larger
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8345 than the first non-singleton dimension of the matrix. In this case,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8346 @code{diff} continues to take the differences along the next
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8347 non-singleton dimension.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8348
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8349 The dimension along which to take the difference can be explicitly
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8350 stated with the optional variable @var{dim}. In this case the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8351 @var{k}-th order differences are calculated along this dimension.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8352 In the case where @var{k} exceeds @w{@code{size (@var{x}, @var{dim})}}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8353 an empty matrix is returned.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8354 @seealso{sort, merge}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8355 @end deftypefn */)
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8356 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8357 int nargin = args.length ();
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8358
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8359 if (nargin < 1 \|\| nargin > 3)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8360 print_usage ();
20806 20975a6f677a eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	8361
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23585 diff changeset	8362 if (! (args(0).isnumeric () \|\| args(0).islogical ()))
10880 92c3e8068f28 allow diff(logical) Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	8363 error ("diff: X must be numeric or logical");
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8364
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	8365 int dim = -1;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	8366 octave_idx_type order = 1;
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	8367 if (nargin > 1)
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8368 {
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	8369 if (args(1).is_scalar_type ())
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	8370 order = args(1).idx_type_value (true, false);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	8371 else if (! args(1).is_zero_by_zero ())
20726 25d676f9619c Preface error() messages with name of function when possible. Rik <rik@octave.org> parents: 20720 diff changeset	8372 error ("diff: order K must be a scalar or []");
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	8373 if (order < 0)
20726 25d676f9619c Preface error() messages with name of function when possible. Rik <rik@octave.org> parents: 20720 diff changeset	8374 error ("diff: order K must be non-negative");
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8375 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8376
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	8377 if (nargin > 2)
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	8378 {
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	8379 dim = args(2).int_value (true, false);
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	8380 if (dim < 1 \|\| dim > args(0).ndims ())
20726 25d676f9619c Preface error() messages with name of function when possible. Rik <rik@octave.org> parents: 20720 diff changeset	8381 error ("diff: DIM must be a valid dimension");
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	8382
81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	8383 dim -= 1;
20562 a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	8384 }
a05a0432dff4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	8385
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8386 return do_diff (args(0), order, dim);
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8387 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8388
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8389 /*
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8390 %!assert (diff ([1, 2, 3, 4]), [1, 1, 1])
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8391 %!assert (diff ([1, 3, 7, 19], 2), [2, 8])
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8392 %!assert (diff ([1, 2; 5, 4; 8, 7; 9, 6; 3, 1]), [4, 2; 3, 3; 1, -1; -6, -5])
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8393 %!assert (diff ([1, 2; 5, 4; 8, 7; 9, 6; 3, 1], 3), [-1, -5; -5, 0])
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	8394 %!assert (isempty (diff (1)))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	8395
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	8396 %!error diff ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	8397 %!error diff (1, 2, 3, 4)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	8398 %!error diff ("foo")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	8399 %!error diff ([1, 2; 3, 4], -1)
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	8400 */
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8401
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21129 diff changeset	8402 template <typename T>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	8403 static Array<T>
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8404 do_repelems (const Array<T>& src, const Array<octave_idx_type>& rep)
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8405 {
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8406 Array<T> retval;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8407
30723 08b08b7f05b2 Replace direct calls to C library assert() with Octave specialty functions in libinterp/ (bug #61753) Arun Giridhar <arungiridhar@gmail.com> and Rik <rik@octave.org> parents: 30673 diff changeset	8408 if (rep.ndims () != 2 \|\| rep.rows () != 2)
08b08b7f05b2 Replace direct calls to C library assert() with Octave specialty functions in libinterp/ (bug #61753) Arun Giridhar <arungiridhar@gmail.com> and Rik <rik@octave.org> parents: 30673 diff changeset	8409 error ("repelems: R must be a 2-row, N-column matrix of integers");
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8410
18100 6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	8411 octave_idx_type n = rep.columns ();
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	8412 octave_idx_type l = 0;
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8413 for (octave_idx_type i = 0; i < n; i++)
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8414 {
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8415 octave_idx_type k = rep(1, i);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8416 if (k < 0)
20893 384ff5aa9437 2015 Code Sprint: Eliminate useless return statements after error (). Rik <rik@octave.org> parents: 20884 diff changeset	8417 error ("repelems: second row must contain non-negative numbers");
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8418
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8419 l += k;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8420 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8421
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8422 retval.clear (1, l);
32660 f53ac65ffba6 maint: New method rwdata() as clearer alternative to fortran_vec(). Rik <rik@octave.org> parents: 32633 diff changeset	8423 T *dest = retval.rwdata ();
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8424 l = 0;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8425 for (octave_idx_type i = 0; i < n; i++)
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8426 {
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8427 octave_idx_type k = rep(1, i);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8428 std::fill_n (dest, k, src.checkelem (rep(0, i) - 1));
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8429 dest += k;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8430 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8431
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8432 return retval;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8433 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8434
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8435 DEFUN (repelems, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8436 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30854 diff changeset	8437 @deftypefn {} {@var{y} =} repelems (@var{x}, @var{r})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8438 Construct a vector of repeated elements from @var{x}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8439
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8440 @var{r} is a 2x@var{N} integer matrix specifying which elements to repeat
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8441 and how often to repeat each element. Entries in the first row,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8442 @var{r}(1,j), select an element to repeat. The corresponding entry in the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8443 second row, @var{r}(2,j), specifies the repeat count. If @var{x} is a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8444 matrix then the columns of @var{x} are imagined to be stacked on top of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8445 each other for purposes of the selection index. A row vector is always
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8446 returned.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8447
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8448 Conceptually the result is calculated as follows:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8449
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8450 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8451 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8452 y = [];
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8453 for i = 1:columns (@var{r})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8454 y = [y, @var{x}(@var{r}(1,i)*ones(1, @var{r}(2,i)))];
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8455 endfor
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8456 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8457 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8458 @seealso{repmat, cat}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8459 @end deftypefn */)
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8460 {
20850 b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8461 if (args.length () != 2)
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8462 print_usage ();
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8463
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8464 octave_value retval;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8465
20850 b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8466 const Matrix rm = args(1).matrix_value ();
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8467
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8468 if (rm.rows () != 2 \|\| rm.ndims () != 2)
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8469 error ("repelems: R must be a matrix with two rows");
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8470
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8471 octave_value x = args(0);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8472
27666 3e8faed1b7d8 Remove wrapper template class NoAlias<T> (bug #56752) Carlo de Falco <carlo.defalco@polimi.it> parents: 27568 diff changeset	8473 Array<octave_idx_type> r (rm.dims ());
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8474
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8475 for (octave_idx_type i = 0; i < rm.numel (); i++)
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8476 {
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8477 octave_idx_type rx = rm(i);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8478 if (static_cast<double> (rx) != rm(i))
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8479 error ("repelems: R must be a matrix of integers");
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8480
27666 3e8faed1b7d8 Remove wrapper template class NoAlias<T> (bug #56752) Carlo de Falco <carlo.defalco@polimi.it> parents: 27568 diff changeset	8481 r.xelem (i) = rx;
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8482 }
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8483
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8484 switch (x.builtin_type ())
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8485 {
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	8486 #define BTYP_BRANCH(X, EX) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	8487 case btyp_ ## X: \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	8488 retval = do_repelems (x.EX ## _value (), r); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	8489 break;
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8490
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8491 BTYP_BRANCH (double, array);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8492 BTYP_BRANCH (float, float_array);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8493 BTYP_BRANCH (complex, complex_array);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8494 BTYP_BRANCH (float_complex, float_complex_array);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8495 BTYP_BRANCH (bool, bool_array);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8496 BTYP_BRANCH (char, char_array);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8497
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8498 BTYP_BRANCH (int8, int8_array);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8499 BTYP_BRANCH (int16, int16_array);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8500 BTYP_BRANCH (int32, int32_array);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8501 BTYP_BRANCH (int64, int64_array);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8502 BTYP_BRANCH (uint8, uint8_array);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8503 BTYP_BRANCH (uint16, uint16_array);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8504 BTYP_BRANCH (uint32, uint32_array);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8505 BTYP_BRANCH (uint64, uint64_array);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8506
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8507 BTYP_BRANCH (cell, cell);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8508 //BTYP_BRANCH (struct, map);//FIXME
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	8509
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8510 #undef BTYP_BRANCH
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8511
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8512 default:
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21078 diff changeset	8513 err_wrong_type_arg ("repelems", x);
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8514 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8515
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8516 return retval;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8517 }
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8518
15252 fa0118cb67d9 move base64 encode and decode functionality to liboctave John W. Eaton <jwe@octave.org> parents: 15213 diff changeset	8519 DEFUN (base64_encode, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8520 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8521 @deftypefn {} {@var{s} =} base64_encode (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8522 Encode a double matrix or array @var{x} into the base64 format string
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8523 @var{s}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8524
28769 903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8525 @seealso{base64_decode, matlab.net.base64decode, matlab.net.base64encode}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8526 @end deftypefn */)
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8527 {
20819 f428cbe7576f eliminate unnecessary uses of nargin John W. Eaton <jwe@octave.org> parents: 20816 diff changeset	8528 if (args.length () != 1)
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8529 print_usage ();
20850 b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8530
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23585 diff changeset	8531 if (! args(0).isnumeric ())
20850 b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8532 error ("base64_encode: encoding is supported only for numeric arrays");
20980 81c2b14c209f maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	8533
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	8534 if (args(0).iscomplex () \|\| args(0).issparse ())
20850 b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8535 error ("base64_encode: encoding complex or sparse data is not supported");
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8536
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8537 octave_value_list retval;
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20893 diff changeset	8538
23580 2230f9e10fb3 maint: Deprecate is_integer_type and replace with isinteger. Rik <rik@octave.org> parents: 23579 diff changeset	8539 if (args(0).isinteger ())
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8540 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	8541 #define MAKE_INT_BRANCH(X) \
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	8542 if (args(0).is_ ## X ## _type ()) \
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	8543 { \
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	8544 const X##NDArray in = args(0). X## _array_value (); \
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	8545 std::size_t inlen = in.numel () * sizeof (X## _t) / sizeof (char); \
23449 c763214a8260 maint: Use convention 'int x' for naming pointers. Rik <rik@octave.org>* parents: 23447 diff changeset	8546 const char inc = reinterpret_cast<const char > (in.data ()); \
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	8547 char *out; \
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	8548 if (base64_encode (inc, inlen, &out)) \
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	8549 { \
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	8550 retval(0) = octave_value (out); \
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	8551 ::free (out); \
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	8552 } \
15111 5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8553 }
20850 b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8554
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8555 MAKE_INT_BRANCH(int8)
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8556 else MAKE_INT_BRANCH(int16)
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	8557 else MAKE_INT_BRANCH(int32)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	8558 else MAKE_INT_BRANCH(int64)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	8559 else MAKE_INT_BRANCH(uint8)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	8560 else MAKE_INT_BRANCH(uint16)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	8561 else MAKE_INT_BRANCH(uint32)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	8562 else MAKE_INT_BRANCH(uint64)
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22079 diff changeset	8563
20850 b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8564 #undef MAKE_INT_BRANCH
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8565
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	8566 else
33382 79cfa1b7a813 replace nearly all remaining uses of panic_impossible with error John W. Eaton <jwe@octave.org> parents: 33365 diff changeset	8567 error ("base_64_decode: unexpected integer type - please report this bug");
20850 b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8568 }
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8569 else if (args(0).is_single_type ())
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8570 {
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8571 const Array<float> in = args(0).float_array_value ();
29654 d13d090cb03a use std::size_t and std::ptrdiff_t in C++ code (bug #60471) John W. Eaton <jwe@octave.org> parents: 29514 diff changeset	8572 std::size_t inlen;
20850 b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8573 inlen = in.numel () * sizeof (float) / sizeof (char);
30390 a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30377 diff changeset	8574 const char *inc;
23447 db1fdf4384dd maint: Use convention "static_cast<void >" for casting of pointers. Rik <rik@octave.org>* parents: 23289 diff changeset	8575 inc = reinterpret_cast<const char *> (in.data ());
23449 c763214a8260 maint: Use convention 'int x' for naming pointers. Rik <rik@octave.org>* parents: 23447 diff changeset	8576 char *out;
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	8577 if (base64_encode (inc, inlen, &out))
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8578 {
20850 b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8579 retval(0) = octave_value (out);
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8580 ::free (out);
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8581 }
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8582 }
20850 b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8583 else // double_type
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8584 {
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8585 const Array<double> in = args(0).array_value ();
29654 d13d090cb03a use std::size_t and std::ptrdiff_t in C++ code (bug #60471) John W. Eaton <jwe@octave.org> parents: 29514 diff changeset	8586 std::size_t inlen;
20850 b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8587 inlen = in.numel () * sizeof (double) / sizeof (char);
30390 a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30377 diff changeset	8588 const char *inc;
23447 db1fdf4384dd maint: Use convention "static_cast<void >" for casting of pointers. Rik <rik@octave.org>* parents: 23289 diff changeset	8589 inc = reinterpret_cast<const char *> (in.data ());
23449 c763214a8260 maint: Use convention 'int x' for naming pointers. Rik <rik@octave.org>* parents: 23447 diff changeset	8590 char *out;
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	8591 if (base64_encode (inc, inlen, &out))
20850 b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8592 {
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8593 retval(0) = octave_value (out);
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8594 ::free (out);
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8595 }
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8596 }
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8597
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8598 return retval;
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8599 }
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8600
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8601 /*
21458 348e335c49dd Fix failing BIST tests on big-endian systems Mike Miller <mtmiller@octave.org> parents: 21405 diff changeset	8602 %!test
348e335c49dd Fix failing BIST tests on big-endian systems Mike Miller <mtmiller@octave.org> parents: 21405 diff changeset	8603 %! ## FIXME: better test for endianness?
348e335c49dd Fix failing BIST tests on big-endian systems Mike Miller <mtmiller@octave.org> parents: 21405 diff changeset	8604 %! if (bitunpack (uint16 (1))(1) == 1)
348e335c49dd Fix failing BIST tests on big-endian systems Mike Miller <mtmiller@octave.org> parents: 21405 diff changeset	8605 %! expected = "2w9JQA==";
348e335c49dd Fix failing BIST tests on big-endian systems Mike Miller <mtmiller@octave.org> parents: 21405 diff changeset	8606 %! else
348e335c49dd Fix failing BIST tests on big-endian systems Mike Miller <mtmiller@octave.org> parents: 21405 diff changeset	8607 %! expected = "QEkP2w==";
348e335c49dd Fix failing BIST tests on big-endian systems Mike Miller <mtmiller@octave.org> parents: 21405 diff changeset	8608 %! endif
348e335c49dd Fix failing BIST tests on big-endian systems Mike Miller <mtmiller@octave.org> parents: 21405 diff changeset	8609 %! assert (base64_encode (single (pi)), expected);
348e335c49dd Fix failing BIST tests on big-endian systems Mike Miller <mtmiller@octave.org> parents: 21405 diff changeset	8610
15111 5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8611 %!assert (base64_encode (uint8 ([0 0 0])), "AAAA")
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8612 %!assert (base64_encode (uint16 ([0 0 0])), "AAAAAAAA")
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8613 %!assert (base64_encode (uint32 ([0 0 0])), "AAAAAAAAAAAAAAAA")
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8614 %!assert (base64_encode (uint64 ([0 0 0])), "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA")
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8615 %!assert (base64_encode (uint8 ([255 255 255])), "////")
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8616
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8617 %!error base64_encode ()
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8618 %!error base64_encode (1,2)
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8619 %!error base64_encode ("A string")
15111 5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8620 %!error base64_encode ({"A cell array"})
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8621 %!error base64_encode (struct ())
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8622 */
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8623
15252 fa0118cb67d9 move base64 encode and decode functionality to liboctave John W. Eaton <jwe@octave.org> parents: 15213 diff changeset	8624 DEFUN (base64_decode, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8625 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8626 @deftypefn {} {@var{x} =} base64_decode (@var{s})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8627 @deftypefnx {} {@var{x} =} base64_decode (@var{s}, @var{dims})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8628 Decode the double matrix or array @var{x} from the base64 encoded string
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8629 @var{s}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8630
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8631 The optional input parameter @var{dims} should be a vector containing the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8632 dimensions of the decoded array.
28769 903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8633 @seealso{base64_encode, matlab.net.base64decode, matlab.net.base64encode}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21947 diff changeset	8634 @end deftypefn */)
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8635 {
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8636 int nargin = args.length ();
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8637
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8638 if (nargin < 1 \|\| nargin > 2)
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8639 print_usage ();
20850 b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8640
33448 71317c258da9 improve argument checking in base64_decode functions John W. Eaton <jwe@octave.org> parents: 33446 diff changeset	8641 std::string str = args(0).xstring_value ("base64_decode: first argument must be a character array");
20850 b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8642
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	8643 Array<double> retval = base64_decode (str);
20850 b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8644
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8645 if (nargin == 2)
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8646 {
15252 fa0118cb67d9 move base64 encode and decode functionality to liboctave John W. Eaton <jwe@octave.org> parents: 15213 diff changeset	8647 dim_vector dims;
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8648
27277 db687716fed6 style fixes: generally aim to break long lines before operators, not after John W. Eaton <jwe@octave.org> parents: 27081 diff changeset	8649 const Array<octave_idx_type> size
db687716fed6 style fixes: generally aim to break long lines before operators, not after John W. Eaton <jwe@octave.org> parents: 27081 diff changeset	8650 = args(1).octave_idx_type_vector_value ();
20850 b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8651
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8652 dims = dim_vector::alloc (size.numel ());
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8653 for (octave_idx_type i = 0; i < size.numel (); i++)
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8654 dims(i) = size(i);
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8655
b36aa3044bca 2015 Code sprint: data.cc: recode instances of print_usage. Rik <rik@octave.org> parents: 20819 diff changeset	8656 retval = retval.reshape (dims);
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8657 }
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8658
21127 df7891224709 maint: Use "return ovl (...)" in DEFUN macros. Rik <rik@octave.org> parents: 21121 diff changeset	8659 return ovl (retval);
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8660 }
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8661
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8662 /*
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8663 %!assert (base64_decode (base64_encode (pi)), pi)
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8664 %!
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8665 %!test
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8666 %! in = randn (10);
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8667 %! outv = base64_decode (base64_encode (in));
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8668 %! outm = base64_decode (base64_encode (in), size (in));
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8669 %! assert (outv, in(:).');
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8670 %! assert (outm, in);
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8671
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8672 %!error base64_decode ()
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8673 %!error base64_decode (1,2,3)
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8674 %!error base64_decode (1, "this is not a valid set of dimensions")
33448 71317c258da9 improve argument checking in base64_decode functions John W. Eaton <jwe@octave.org> parents: 33446 diff changeset	8675 %!error <first argument must be a character array> base64_decode (1)
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8676 %!error <input was not valid base64> base64_decode ("AQ=")
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8677 %!error <incorrect input size> base64_decode ("AQ==")
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8678 */
28769 903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8679
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8680 DEFUN (__base64_decode_bytes__, args, ,
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8681 doc: /* -- texinfo --
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8682 @deftypefn {} {@var{x} =} base64_decode_bytes (@var{s})
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8683 @deftypefnx {} {@var{x} =} base64_decode_bytes (@var{s}, @var{dims})
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8684 Decode the uint8 matrix or array @var{x} from the base64 encoded string
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8685 @var{s}.
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8686
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8687 The optional input parameter @var{dims} should be a vector containing the
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8688 dimensions of the decoded array.
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8689 @seealso{base64_decode}
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8690 @end deftypefn */)
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8691 {
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8692 int nargin = args.length ();
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8693
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8694 if (nargin < 1 \|\| nargin > 2)
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8695 print_usage ();
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8696
33448 71317c258da9 improve argument checking in base64_decode functions John W. Eaton <jwe@octave.org> parents: 33446 diff changeset	8697 std::string str = args(0).xstring_value ("__base64_decode_bytes__: first argument must be a character array");
28769 903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8698
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29959 diff changeset	8699 intNDArray<octave_uint8> retval = base64_decode_bytes (str);
28769 903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8700
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8701 if (nargin == 2)
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8702 {
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8703 dim_vector dims;
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8704
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8705 const Array<octave_idx_type> size
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8706 = args(1).octave_idx_type_vector_value ();
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8707
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8708 dims = dim_vector::alloc (size.numel ());
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8709 for (octave_idx_type i = 0; i < size.numel (); i++)
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8710 dims(i) = size(i);
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8711
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8712 retval = retval.reshape (dims);
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8713 }
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8714
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8715 return ovl (retval);
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8716 }
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8717
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8718 /*
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8719 %!assert (__base64_decode_bytes__ (base64_encode (uint8 (1))), uint8 (1))
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8720
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8721 %!test
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8722 %! in = uint8 (rand (10)*255);
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8723 %! outv = __base64_decode_bytes__ (base64_encode (in));
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8724 %! outm = __base64_decode_bytes__ (base64_encode (in), size (in));
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8725 %! assert (outv, in(:).');
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8726 %! assert (outm, in);
903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8727
28888 06c8e0877864 maint: Backed out changeset 09c071328135. Rik <rik@octave.org> parents: 28887 diff changeset	8728 %!error __base64_decode_bytes__ ()
06c8e0877864 maint: Backed out changeset 09c071328135. Rik <rik@octave.org> parents: 28887 diff changeset	8729 %!error __base64_decode_bytes__ (1,2,3)
28769 903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8730 %!error __base64_decode_bytes__ (1, "this is not a valid set of dimensions")
33448 71317c258da9 improve argument checking in base64_decode functions John W. Eaton <jwe@octave.org> parents: 33446 diff changeset	8731 %!error <first argument must be a character array> __base64_decode_bytes__ (1)
28769 903fe321649b Add Matlab compatible wrappers for base64_encode and base64_decode. Markus Mützel <markus.muetzel@gmx.de> parents: 28715 diff changeset	8732 */
29958 32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29955 diff changeset	8733
31605 e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 31603 diff changeset	8734 OCTAVE_END_NAMESPACE(octave)

Mercurial > octave

annotate libinterp/corefcn/data.cc @ 33555:a8346c5f6997