octave-avbm: src/data.cc annotate

annotate src/data.cc @ 12570:1a93988610a3

Reverse changset cc8ccdfec424. Restore 3-input form of diag().

author	Rik <octave@nomad.inbox5.com>
date	Sun, 03 Apr 2011 07:00:34 -0700
parents	cc8ccdfec424
children	bed932910eb9

rev	line source
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1 /*
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 11435 diff changeset	3 Copyright (C) 1994-2011 John W. Eaton
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	4 Copyright (C) 2009 Jaroslav Hajek
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 11435 diff changeset	5 Copyright (C) 2009-2010 VZLU Prague
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	6
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	7 This file is part of Octave.
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	8
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	9 Octave is free software; you can redistribute it and/or modify it
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	10 under the terms of the GNU General Public License as published by the
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7007 diff changeset	11 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7007 diff changeset	12 option) any later version.
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	13
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	14 Octave is distributed in the hope that it will be useful, but WITHOUT
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	15 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	16 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	17 for more details.
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	18
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	19 You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7007 diff changeset	20 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7007 diff changeset	21 <http://www.gnu.org/licenses/>.
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	22
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	23 */
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	24
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	25 #ifdef HAVE_CONFIG_H
1192 b6360f2d4fa6 [project @ 1995-03-30 21:38:35 by jwe] jwe parents: 1129 diff changeset	26 #include <config.h>
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	27 #endif
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	28
7078 405cf85b435c [project @ 2007-10-30 14:04:59 by jwe] jwe parents: 7065 diff changeset	29 #include <sys/types.h>
10302 5669a0b893db data.cc: include <sys/times.h> and ensure that HZ is defined John W. Eaton <jwe@octave.org> parents: 10293 diff changeset	30 #include <sys/times.h>
7078 405cf85b435c [project @ 2007-10-30 14:04:59 by jwe] jwe parents: 7065 diff changeset	31
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe] jwe parents: 7065 diff changeset	32 #ifdef HAVE_SYS_RESOURCE_H
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe] jwe parents: 7065 diff changeset	33 #include <sys/resource.h>
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe] jwe parents: 7065 diff changeset	34 #endif
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe] jwe parents: 7065 diff changeset	35
2184 dbbbb3559ee8 [project @ 1996-05-14 02:18:22 by jwe] jwe parents: 2086 diff changeset	36 #include <cfloat>
10303 e4899d6320b6 data.cc: use CLOCKS_PER_SEC instead of HZ John W. Eaton <jwe@octave.org> parents: 10302 diff changeset	37 #include <ctime>
2184 dbbbb3559ee8 [project @ 1996-05-14 02:18:22 by jwe] jwe parents: 2086 diff changeset	38
1728 42b4f904f1af [project @ 1996-01-09 11:36:01 by jwe] jwe parents: 1572 diff changeset	39 #include <string>
42b4f904f1af [project @ 1996-01-09 11:36:01 by jwe] jwe parents: 1572 diff changeset	40
2184 dbbbb3559ee8 [project @ 1996-05-14 02:18:22 by jwe] jwe parents: 2086 diff changeset	41 #include "lo-ieee.h"
7231 2eb392d058bb [project @ 2007-11-30 18:53:29 by jwe] jwe parents: 7189 diff changeset	42 #include "lo-math.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"
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1742 diff changeset	44 #include "str-vec.h"
4153 6b96ce9f5743 [project @ 2002-11-06 20:38:49 by jwe] jwe parents: 4114 diff changeset	45 #include "quit.h"
9658 3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	46 #include "mx-base.h"
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	47 #include "oct-binmap.h"
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1742 diff changeset	48
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	49 #include "Cell.h"
1352 19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1315 diff changeset	50 #include "defun.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1315 diff changeset	51 #include "error.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1315 diff changeset	52 #include "gripes.h"
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	53 #include "oct-map.h"
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	54 #include "oct-obj.h"
2366 c90105b99479 [project @ 1996-10-11 23:22:27 by jwe] jwe parents: 2305 diff changeset	55 #include "ov.h"
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	56 #include "ov-float.h"
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	57 #include "ov-complex.h"
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	58 #include "ov-flt-complex.h"
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	59 #include "ov-cx-mat.h"
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	60 #include "ov-flt-cx-mat.h"
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	61 #include "ov-cx-sparse.h"
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	62 #include "parse.h"
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	63 #include "pt-mat.h"
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	64 #include "utils.h"
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	65 #include "variables.h"
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	66 #include "pager.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
10303 e4899d6320b6 data.cc: use CLOCKS_PER_SEC instead of HZ John W. Eaton <jwe@octave.org> parents: 10302 diff changeset	69 #if ! defined (CLOCKS_PER_SEC)
10302 5669a0b893db data.cc: include <sys/times.h> and ensure that HZ is defined John W. Eaton <jwe@octave.org> parents: 10293 diff changeset	70 #if defined (CLK_TCK)
10303 e4899d6320b6 data.cc: use CLOCKS_PER_SEC instead of HZ John W. Eaton <jwe@octave.org> parents: 10302 diff changeset	71 #define CLOCKS_PER_SEC CLK_TCK
10302 5669a0b893db data.cc: include <sys/times.h> and ensure that HZ is defined John W. Eaton <jwe@octave.org> parents: 10293 diff changeset	72 #else
10303 e4899d6320b6 data.cc: use CLOCKS_PER_SEC instead of HZ John W. Eaton <jwe@octave.org> parents: 10302 diff changeset	73 #error "no definition for CLOCKS_PER_SEC!"
10302 5669a0b893db data.cc: include <sys/times.h> and ensure that HZ is defined John W. Eaton <jwe@octave.org> parents: 10293 diff changeset	74 #endif
5669a0b893db data.cc: include <sys/times.h> and ensure that HZ is defined John W. Eaton <jwe@octave.org> parents: 10293 diff changeset	75 #endif
5669a0b893db data.cc: include <sys/times.h> and ensure that HZ is defined John W. Eaton <jwe@octave.org> parents: 10293 diff changeset	76
7914 e998e81224b5 Various compilation fixes for MSVC. John W. Eaton <jwe@octave.org> parents: 7815 diff changeset	77 #if ! defined (HAVE_HYPOTF) && defined (HAVE__HYPOTF)
e998e81224b5 Various compilation fixes for MSVC. John W. Eaton <jwe@octave.org> parents: 7815 diff changeset	78 #define hypotf _hypotf
e998e81224b5 Various compilation fixes for MSVC. John W. Eaton <jwe@octave.org> parents: 7815 diff changeset	79 #define HAVE_HYPOTF 1
e998e81224b5 Various compilation fixes for MSVC. John W. Eaton <jwe@octave.org> parents: 7815 diff changeset	80 #endif
e998e81224b5 Various compilation fixes for MSVC. John W. Eaton <jwe@octave.org> parents: 7815 diff changeset	81
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	82 #define ANY_ALL(FCN) \
6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	83 \
4233 ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe] jwe parents: 4176 diff changeset	84 octave_value retval; \
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	85 \
6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	86 int nargin = args.length (); \
6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	87 \
4021 963507f8caf4 [project @ 2002-08-05 22:22:16 by jwe] jwe parents: 4015 diff changeset	88 if (nargin == 1 \|\| nargin == 2) \
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	89 { \
4021 963507f8caf4 [project @ 2002-08-05 22:22:16 by jwe] jwe parents: 4015 diff changeset	90 int dim = (nargin == 1 ? -1 : args(1).int_value (true) - 1); \
963507f8caf4 [project @ 2002-08-05 22:22:16 by jwe] jwe parents: 4015 diff changeset	91 \
963507f8caf4 [project @ 2002-08-05 22:22:16 by jwe] jwe parents: 4015 diff changeset	92 if (! error_state) \
963507f8caf4 [project @ 2002-08-05 22:22:16 by jwe] jwe parents: 4015 diff changeset	93 { \
4556 773a21e4fce8 [project @ 2003-10-28 05:02:10 by jwe] jwe parents: 4554 diff changeset	94 if (dim >= -1) \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	95 retval = args(0).FCN (dim); \
4021 963507f8caf4 [project @ 2002-08-05 22:22:16 by jwe] jwe parents: 4015 diff changeset	96 else \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	97 error (#FCN ": invalid dimension argument = %d", dim + 1); \
4021 963507f8caf4 [project @ 2002-08-05 22:22:16 by jwe] jwe parents: 4015 diff changeset	98 } \
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	99 else \
4021 963507f8caf4 [project @ 2002-08-05 22:22:16 by jwe] jwe parents: 4015 diff changeset	100 error (#FCN ": expecting dimension argument to be an integer"); \
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	101 } \
4021 963507f8caf4 [project @ 2002-08-05 22:22:16 by jwe] jwe parents: 4015 diff changeset	102 else \
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	103 print_usage (); \
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	104 \
6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	105 return retval
6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	106
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	107 DEFUN (all, args, ,
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	108 "-- texinfo --\n\
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	109 @deftypefn {Built-in Function} {} all (@var{x}, @var{dim})\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	110 The function @code{all} behaves like the function @code{any}, except\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	111 that it returns true only if all the elements of a vector, or all the\n\
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	112 elements along dimension @var{dim} of a matrix, are nonzero.\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	113 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	114 {
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	115 ANY_ALL (all);
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	116 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	117
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	118 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	119
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	120 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	121 %! 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	122 %! x(1,1) = 0;
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	123 %! assert((all (all (rand (3) + 1) == [1, 1, 1]) == 1
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	124 %! && all (all (x) == [0, 1, 1]) == 1
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	125 %! && all (x, 1) == [0, 1, 1]
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	126 %! && all (x, 2) == [0; 1; 1]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	127
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	128 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	129 %! x = ones (3, 'single');
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	130 %! x(1,1) = 0;
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	131 %! assert((all (all (single (rand (3) + 1)) == [1, 1, 1]) == 1
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	132 %! && all (all (x) == [0, 1, 1]) == 1
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	133 %! && all (x, 1) == [0, 1, 1]
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	134 %! && all (x, 2) == [0; 1; 1]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	135
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	136 %!error <Invalid call to all.*> all ();
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	137 %!error <Invalid call to all.*> all (1, 2, 3);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	138
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	139 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	140
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	141 DEFUN (any, args, ,
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	142 "-- texinfo --\n\
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	143 @deftypefn {Built-in Function} {} any (@var{x}, @var{dim})\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	144 For a vector argument, return 1 if any element of the vector is\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	145 nonzero.\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	146 \n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	147 For a matrix argument, return a row vector of ones and\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	148 zeros with each element indicating whether any of the elements of the\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	149 corresponding column of the matrix are nonzero. For example:\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	150 \n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	151 @example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	152 @group\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	153 any (eye (2, 4))\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	154 @result{} [ 1, 1, 0, 0 ]\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	155 @end group\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	156 @end example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	157 \n\
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	158 If the optional argument @var{dim} is supplied, work along dimension\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	159 @var{dim}. For example:\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	160 \n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	161 @example\n\
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	162 @group\n\
6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	163 any (eye (2, 4), 2)\n\
6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	164 @result{} [ 1; 1 ]\n\
6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	165 @end group\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	166 @end example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	167 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	168 {
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	169 ANY_ALL (any);
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
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	174 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	175 %! 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	176 %! x(3,3) = 1;
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	177 %! assert((all (any (x) == [0, 0, 1]) == 1
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	178 %! && all (any (ones (3)) == [1, 1, 1]) == 1
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	179 %! && any (x, 1) == [0, 0, 1]
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	180 %! && any (x, 2) == [0; 0; 1]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	181
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	182 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	183 %! x = zeros (3,'single');
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	184 %! x(3,3) = 1;
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	185 %! assert((all (any (x) == [0, 0, 1]) == 1
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	186 %! && all (any (ones (3, 'single')) == [1, 1, 1]) == 1
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	187 %! && any (x, 1) == [0, 0, 1]
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	188 %! && any (x, 2) == [0; 0; 1]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	189
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	190 %!error <Invalid call to any.*> any ();
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	191 %!error <Invalid call to any.*> any (1, 2, 3);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	192
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	193 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	194
649 1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	195 // 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	196
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	197 DEFUN (atan2, args, ,
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	198 "-- texinfo --\n\
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	199 @deftypefn {Mapping Function} {} atan2 (@var{y}, @var{x})\n\
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	200 Compute atan (@var{y} / @var{x}) for corresponding elements of @var{y}\n\
9155 ad20b967e1c9 Update section 17.3 (Trigonometry) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9142 diff changeset	201 and @var{x}. Signal an error if @var{y} and @var{x} do not match in size\n\
ad20b967e1c9 Update section 17.3 (Trigonometry) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9142 diff changeset	202 and orientation.\n\
3439 3234a698073a [project @ 2000-01-14 09:51:14 by jwe] jwe parents: 3428 diff changeset	203 @end deftypefn")
649 1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	204 {
4233 ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe] jwe parents: 4176 diff changeset	205 octave_value retval;
649 1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	206
712 36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	207 int nargin = args.length ();
36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	208
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	209 if (nargin == 2)
649 1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	210 {
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	211 if (! args(0).is_numeric_type ())
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	212 gripe_wrong_type_arg ("atan2", args(0));
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	213 else if (! args(1).is_numeric_type ())
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	214 gripe_wrong_type_arg ("atan2", args(1));
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	215 else if (args(0).is_complex_type () \|\| args(1).is_complex_type ())
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	216 error ("atan2: not defined for complex numbers");
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	217 else if (args(0).is_single_type () \|\| args(1).is_single_type ())
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	218 {
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	219 if (args(0).is_scalar_type () && args(1).is_scalar_type ())
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	220 retval = atan2f (args(0).float_value (), args(1).float_value ());
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	221 else
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	222 {
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	223 FloatNDArray a0 = args(0).float_array_value ();
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	224 FloatNDArray a1 = args(1).float_array_value ();
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	225 retval = binmap<float> (a0, a1, ::atan2f, "atan2");
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	226 }
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	227 }
7494 bd2bd04e68ca Treat integer types for mod/rem correctly David Bateman <dbateman@free.fr> parents: 7433 diff changeset	228 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	229 {
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	230 bool a0_scalar = args(0).is_scalar_type ();
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	231 bool a1_scalar = args(1).is_scalar_type ();
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	232 if (a0_scalar && a1_scalar)
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	233 retval = atan2 (args(0).scalar_value (), args(1).scalar_value ());
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	234 else if ((a0_scalar \|\| args(0).is_sparse_type ())
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	235 && (a1_scalar \|\| args(1).is_sparse_type ()))
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	236 {
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	237 SparseMatrix m0 = args(0).sparse_matrix_value ();
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	238 SparseMatrix m1 = args(1).sparse_matrix_value ();
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	239 retval = binmap<double> (m0, m1, ::atan2, "atan2");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	240 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	241 else
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	242 {
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	243 NDArray a0 = args(0).array_value ();
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	244 NDArray a1 = args(1).array_value ();
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	245 retval = binmap<double> (a0, a1, ::atan2, "atan2");
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	246 }
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	247 }
649 1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	248 }
712 36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	249 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	250 print_usage ();
649 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];
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	268 %! assert(atan2 (y, x), v, sqrt (eps));
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);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	273 %! v = single([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	274 %! y = single([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	275 %! x = single([1, 3, 1, 1, 1, 1, 3, 1]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	276 %! assert(atan2 (y, x), v, sqrt (eps('single')));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	277
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	278 %!error <Invalid call to atan2.*> atan2 ();
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	279 %!error <Invalid call to atan2.*> atan2 (1, 2, 3);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	280
7506 798b0a00e80c atan2, fmod: accept N-d arrays John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	281 */
798b0a00e80c atan2, fmod: accept N-d arrays John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	282
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	283
10538 26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	284 static octave_value
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	285 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	286 {
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	287 octave_value retval;
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	288
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	289 octave_value arg0 = x, arg1 = y;
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	290 if (! arg0.is_numeric_type ())
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	291 gripe_wrong_type_arg ("hypot", arg0);
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	292 else if (! arg1.is_numeric_type ())
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	293 gripe_wrong_type_arg ("hypot", arg1);
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	294 else
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	295 {
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	296 if (arg0.is_complex_type ())
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	297 arg0 = arg0.abs ();
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	298 if (arg1.is_complex_type ())
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	299 arg1 = arg1.abs ();
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	300
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	301 if (arg0.is_single_type () \|\| arg1.is_single_type ())
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	302 {
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	303 if (arg0.is_scalar_type () && arg1.is_scalar_type ())
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	304 retval = hypotf (arg0.float_value (), arg1.float_value ());
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	305 else
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	306 {
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	307 FloatNDArray a0 = arg0.float_array_value ();
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	308 FloatNDArray a1 = arg1.float_array_value ();
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	309 retval = binmap<float> (a0, a1, ::hypotf, "hypot");
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	310 }
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	311 }
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	312 else
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	313 {
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	314 bool a0_scalar = arg0.is_scalar_type ();
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	315 bool a1_scalar = arg1.is_scalar_type ();
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	316 if (a0_scalar && a1_scalar)
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	317 retval = hypot (arg0.scalar_value (), arg1.scalar_value ());
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	318 else if ((a0_scalar \|\| arg0.is_sparse_type ())
10538 26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	319 && (a1_scalar \|\| arg1.is_sparse_type ()))
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	320 {
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	321 SparseMatrix m0 = arg0.sparse_matrix_value ();
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	322 SparseMatrix m1 = arg1.sparse_matrix_value ();
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	323 retval = binmap<double> (m0, m1, ::hypot, "hypot");
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	324 }
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	325 else
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	326 {
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	327 NDArray a0 = arg0.array_value ();
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	328 NDArray a1 = arg1.array_value ();
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	329 retval = binmap<double> (a0, a1, ::hypot, "hypot");
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	330 }
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	331 }
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	332 }
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	333
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	334 return retval;
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	335 }
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	336
7631 b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	337 DEFUN (hypot, args, ,
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	338 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	339 @deftypefn {Built-in Function} {} hypot (@var{x}, @var{y})\n\
10711 fbd7843974fa Periodic grammar check of documentation files to ensure common format. Rik <octave@nomad.inbox5.com> parents: 10707 diff changeset	340 @deftypefnx {Built-in Function} {} hypot (@var{x}, @var{y}, @var{z}, @dots{})\n\
9165 8c71a86c4bf4 Update section 17.5 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9163 diff changeset	341 Compute the element-by-element square root of the sum of the squares of\n\
8c71a86c4bf4 Update section 17.5 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9163 diff changeset	342 @var{x} and @var{y}. This is equivalent to\n\
8c71a86c4bf4 Update section 17.5 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9163 diff changeset	343 @code{sqrt (@var{x}.^2 + @var{y}.^2)}, but calculated in a manner that\n\
8c71a86c4bf4 Update section 17.5 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9163 diff changeset	344 avoids overflows for large values of @var{x} or @var{y}.\n\
10538 26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	345 @code{hypot} can also be called with more than 2 arguments; in this case,\n\
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	346 the arguments are accumulated from left to right:\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	347 \n\
10538 26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	348 @example\n\
10711 fbd7843974fa Periodic grammar check of documentation files to ensure common format. Rik <octave@nomad.inbox5.com> parents: 10707 diff changeset	349 @group\n\
10538 26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	350 hypot (hypot (@var{x}, @var{y}), @var{z})\n\
10711 fbd7843974fa Periodic grammar check of documentation files to ensure common format. Rik <octave@nomad.inbox5.com> parents: 10707 diff changeset	351 hypot (hypot (hypot (@var{x}, @var{y}), @var{z}), @var{w}), etc.\n\
fbd7843974fa Periodic grammar check of documentation files to ensure common format. Rik <octave@nomad.inbox5.com> parents: 10707 diff changeset	352 @end group\n\
10538 26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	353 @end example\n\
7631 b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	354 @end deftypefn")
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	355 {
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	356 octave_value retval;
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	357
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	358 int nargin = args.length ();
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	359
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	360 if (nargin == 2)
7631 b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	361 {
10538 26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	362 retval = do_hypot (args(0), args(1));
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	363 }
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	364 else if (nargin >= 3)
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	365 {
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	366 retval = args(0);
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	367 for (int i = 1; i < nargin && ! error_state; i++)
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	368 retval = do_hypot (retval, args(i));
7631 b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	369 }
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	370 else
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	371 print_usage ();
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	372
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	373 return retval;
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	374 }
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	375
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	376 /*
7741 72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	377 %!assert (size (hypot (zeros (0, 2), zeros (0, 2))), [0, 2])
72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	378 %!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	379 %!assert (size (hypot (rand (2, 3, 4), 1)), [2, 3, 4])
72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	380 %!assert (size (hypot (1, rand (2, 3, 4))), [2, 3, 4])
72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	381 %!assert (size (hypot (1, 2)), [1, 1])
72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	382 %!assert (hypot (1:10, 1:10), sqrt(2) * [1:10], 16*eps)
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	383 %!assert (hypot (single(1:10), single(1:10)), single(sqrt(2) * [1:10]));
7631 b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	384 */
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	385
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	386 template<typename T, typename ET>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	387 void
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	388 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	389 {
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	390 f = Array<T>(x.dims ());
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	391 e = Array<ET>(x.dims ());
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	392 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	393 {
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	394 int exp;
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	395 f.xelem (i) = xlog2 (x(i), exp);
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	396 e.xelem (i) = exp;
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	397 }
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	398 }
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	399
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	400 DEFUN (log2, args, nargout,
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	401 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	402 @deftypefn {Mapping Function} {} log2 (@var{x})\n\
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	403 @deftypefnx {Mapping Function} {[@var{f}, @var{e}] =} log2 (@var{x})\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	404 Compute the base-2 logarithm of each element of @var{x}.\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	405 \n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	406 If called with two output arguments, split @var{x} into\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	407 binary mantissa and exponent so that\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	408 @tex\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	409 ${1 \\over 2} \\le \\left\| f \\right\| < 1$\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	410 @end tex\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	411 @ifnottex\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	412 @code{1/2 <= abs(f) < 1}\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	413 @end ifnottex\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	414 and @var{e} is an integer. If\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	415 @tex\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	416 $x = 0$, $f = e = 0$.\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	417 @end tex\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	418 @ifnottex\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	419 @code{x = 0}, @code{f = e = 0}.\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	420 @end ifnottex\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	421 @seealso{pow2, log, log10, exp}\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	422 @end deftypefn")
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	423 {
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	424 octave_value_list retval;
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	425
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	426 if (args.length () == 1)
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	427 {
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	428 if (nargout < 2)
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	429 retval(0) = args(0).log2 ();
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	430 else if (args(0).is_single_type ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	431 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	432 if (args(0).is_real_type ())
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	433 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	434 FloatNDArray f;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	435 FloatNDArray x = args(0).float_array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	436 // FIXME -- should E be an int value?
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	437 FloatMatrix e;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	438 map_2_xlog2 (x, f, e);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	439 retval (1) = e;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	440 retval (0) = f;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	441 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	442 else if (args(0).is_complex_type ())
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	443 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	444 FloatComplexNDArray f;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	445 FloatComplexNDArray x = args(0).float_complex_array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	446 // FIXME -- should E be an int value?
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	447 FloatNDArray e;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	448 map_2_xlog2 (x, f, e);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	449 retval (1) = e;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	450 retval (0) = f;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	451 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	452 }
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	453 else if (args(0).is_real_type ())
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	454 {
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	455 NDArray f;
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	456 NDArray x = args(0).array_value ();
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	457 // FIXME -- should E be an int value?
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	458 Matrix e;
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	459 map_2_xlog2 (x, f, e);
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	460 retval (1) = e;
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	461 retval (0) = f;
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	462 }
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	463 else if (args(0).is_complex_type ())
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	464 {
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	465 ComplexNDArray f;
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	466 ComplexNDArray x = args(0).complex_array_value ();
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	467 // FIXME -- should E be an int value?
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	468 NDArray e;
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	469 map_2_xlog2 (x, f, e);
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	470 retval (1) = e;
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	471 retval (0) = f;
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	472 }
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	473 else
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	474 gripe_wrong_type_arg ("log2", args(0));
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	475 }
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	476 else
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	477 print_usage ();
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	478
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	479 return retval;
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	480 }
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	481
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	482 /*
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	483 %!assert(log2 ([1/4, 1/2, 1, 2, 4]), [-2, -1, 0, 1, 2]);
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	484 %!assert(log2(Inf), Inf);
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	485 %!assert(isnan(log2(NaN)));
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	486 %!assert(log2(4i), 2 + log2(1i));
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	487 %!assert(log2(complex(0,Inf)), Inf + log2(i));
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	488
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	489 %!test
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	490 %! [f, e] = log2 ([0,-1; 2,-4; Inf,-Inf]);
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	491 %! assert (f, [0,-0.5; 0.5,-0.5; Inf,-Inf]);
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	492 %! assert (e(1:2,:), [0,1;2,3])
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	493
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	494 %!test
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	495 %! [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	496 %! 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	497 %! assert (e(1:2,:), [0,1; 2,3]);
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	498 */
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	499
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	500 DEFUN (rem, args, ,
4311 a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	501 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	502 @deftypefn {Mapping Function} {} rem (@var{x}, @var{y})\n\
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	503 @deftypefnx {Mapping Function} {} fmod (@var{x}, @var{y})\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	504 Return the remainder of the division @code{@var{x} / @var{y}}, computed \n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	505 using the expression\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	506 \n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	507 @example\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	508 x - y .* fix (x ./ y)\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	509 @end example\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	510 \n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	511 An error message is printed if the dimensions of the arguments do not\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	512 agree, or if either of the arguments is complex.\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	513 @seealso{mod}\n\
4311 a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	514 @end deftypefn")
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	515 {
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	516 octave_value retval;
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	517
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	518 int nargin = args.length ();
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	519
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	520 if (nargin == 2)
4311 a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	521 {
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	522 if (! args(0).is_numeric_type ())
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	523 gripe_wrong_type_arg ("rem", args(0));
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	524 else if (! args(1).is_numeric_type ())
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	525 gripe_wrong_type_arg ("rem", args(1));
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	526 else if (args(0).is_complex_type () \|\| args(1).is_complex_type ())
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	527 error ("rem: not defined for complex numbers");
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	528 else if (args(0).is_integer_type () \|\| args(1).is_integer_type ())
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	529 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	530 builtin_type_t btyp0 = args(0).builtin_type ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	531 builtin_type_t btyp1 = args(1).builtin_type ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	532 if (btyp0 == btyp_double \|\| btyp0 == btyp_float)
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	533 btyp0 = btyp1;
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	534 if (btyp1 == btyp_double \|\| btyp1 == btyp_float)
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	535 btyp1 = btyp0;
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	536
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	537 if (btyp0 == btyp1)
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	538 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	539 switch (btyp0)
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	540 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	541 #define MAKE_INT_BRANCH(X) \
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	542 case btyp_ ## X: \
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	543 { \
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	544 X##NDArray a0 = args(0).X##_array_value (); \
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	545 X##NDArray a1 = args(1).X##_array_value (); \
10682 7b4ffe27bbb4 Specify template arguments explicitely [MSVC]. Michael Goffioul <michael.goffioul@gmail.com> parents: 10538 diff changeset	546 retval = binmap<octave_##X,octave_##X,octave_##X> (a0, a1, rem, "rem"); \
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	547 } \
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	548 break
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	549 MAKE_INT_BRANCH (int8);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	550 MAKE_INT_BRANCH (int16);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	551 MAKE_INT_BRANCH (int32);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	552 MAKE_INT_BRANCH (int64);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	553 MAKE_INT_BRANCH (uint8);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	554 MAKE_INT_BRANCH (uint16);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	555 MAKE_INT_BRANCH (uint32);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	556 MAKE_INT_BRANCH (uint64);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	557 #undef MAKE_INT_BRANCH
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	558 default:
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	559 panic_impossible ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	560 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	561 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	562 else
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	563 error ("rem: cannot combine %s and %d",
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	564 args(0).class_name ().c_str (), args(1).class_name ().c_str ());
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	565 }
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	566 else if (args(0).is_single_type () \|\| args(1).is_single_type ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	567 {
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	568 if (args(0).is_scalar_type () && args(1).is_scalar_type ())
11209 94d9d412a2a0 improve Matlab compatibility of rem and mod John W. Eaton <jwe@octave.org> parents: 10983 diff changeset	569 retval = xrem (args(0).float_value (), args(1).float_value ());
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	570 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	571 {
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	572 FloatNDArray a0 = args(0).float_array_value ();
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	573 FloatNDArray a1 = args(1).float_array_value ();
11209 94d9d412a2a0 improve Matlab compatibility of rem and mod John W. Eaton <jwe@octave.org> parents: 10983 diff changeset	574 retval = binmap<float> (a0, a1, xrem, "rem");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	575 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	576 }
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	577 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	578 {
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	579 bool a0_scalar = args(0).is_scalar_type ();
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	580 bool a1_scalar = args(1).is_scalar_type ();
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	581 if (a0_scalar && a1_scalar)
11209 94d9d412a2a0 improve Matlab compatibility of rem and mod John W. Eaton <jwe@octave.org> parents: 10983 diff changeset	582 retval = xrem (args(0).scalar_value (), args(1).scalar_value ());
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	583 else if ((a0_scalar \|\| args(0).is_sparse_type ())
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	584 && (a1_scalar \|\| args(1).is_sparse_type ()))
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	585 {
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	586 SparseMatrix m0 = args(0).sparse_matrix_value ();
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	587 SparseMatrix m1 = args(1).sparse_matrix_value ();
11209 94d9d412a2a0 improve Matlab compatibility of rem and mod John W. Eaton <jwe@octave.org> parents: 10983 diff changeset	588 retval = binmap<double> (m0, m1, xrem, "rem");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	589 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	590 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	591 {
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	592 NDArray a0 = args(0).array_value ();
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	593 NDArray a1 = args(1).array_value ();
11209 94d9d412a2a0 improve Matlab compatibility of rem and mod John W. Eaton <jwe@octave.org> parents: 10983 diff changeset	594 retval = binmap<double> (a0, a1, xrem, "rem");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	595 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	596 }
4311 a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	597 }
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	598 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	599 print_usage ();
4311 a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	600
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	601 return retval;
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	602 }
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	603
7506 798b0a00e80c atan2, fmod: accept N-d arrays John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	604 /*
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	605
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	606 %!assert(rem ([1, 2, 3; -1, -2, -3], 2), [1, 0, 1; -1, 0, -1]);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	607 %!assert(rem ([1, 2, 3; -1, -2, -3], 2 * ones (2, 3)),[1, 0, 1; -1, 0, -1]);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	608 %!error rem ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	609 %!error rem (1, 2, 3);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	610 %!error rem ([1, 2], [3, 4, 5]);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	611 %!error rem (i, 1);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	612 %!assert(rem (uint8([1, 2, 3; -1, -2, -3]), uint8 (2)), uint8([1, 0, 1; -1, 0, -1]));
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	613 %!assert(uint8(rem ([1, 2, 3; -1, -2, -3], 2 * ones (2, 3))),uint8([1, 0, 1; -1, 0, -1]));
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	614 %!error rem (uint(8),int8(5));
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	615 %!error rem (uint8([1, 2]), uint8([3, 4, 5]));
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	616
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	617 */
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	618
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	619 /*
7741 72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	620 %!assert (size (fmod (zeros (0, 2), zeros (0, 2))), [0, 2])
72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	621 %!assert (size (fmod (rand (2, 3, 4), zeros (2, 3, 4))), [2, 3, 4])
7743 fbe27e477578 more tests fixed John W. Eaton <jwe@octave.org> parents: 7741 diff changeset	622 %!assert (size (fmod (rand (2, 3, 4), 1)), [2, 3, 4])
fbe27e477578 more tests fixed John W. Eaton <jwe@octave.org> parents: 7741 diff changeset	623 %!assert (size (fmod (1, rand (2, 3, 4))), [2, 3, 4])
fbe27e477578 more tests fixed John W. Eaton <jwe@octave.org> parents: 7741 diff changeset	624 %!assert (size (fmod (1, 2)), [1, 1])
7506 798b0a00e80c atan2, fmod: accept N-d arrays John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	625 */
798b0a00e80c atan2, fmod: accept N-d arrays John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	626
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	627 DEFALIAS (fmod, rem)
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	628
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	629 DEFUN (mod, args, ,
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	630 "-- texinfo --\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	631 @deftypefn {Mapping Function} {} mod (@var{x}, @var{y})\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	632 Compute the modulo of @var{x} and @var{y}. Conceptually this is given by\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	633 \n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	634 @example\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	635 x - y .* floor (x ./ y)\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	636 @end example\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	637 \n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	638 @noindent\n\
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	639 and is written such that the correct modulus is returned for\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	640 integer types. This function handles negative values correctly. That\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	641 is, @code{mod (-1, 3)} is 2, not -1, as @code{rem (-1, 3)} returns.\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	642 @code{mod (@var{x}, 0)} returns @var{x}.\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	643 \n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	644 An error results if the dimensions of the arguments do not agree, or if\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	645 either of the arguments is complex.\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	646 @seealso{rem}\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	647 @end deftypefn")
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	648 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	649 octave_value retval;
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	650
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	651 int nargin = args.length ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	652
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	653 if (nargin == 2)
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	654 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	655 if (! args(0).is_numeric_type ())
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	656 gripe_wrong_type_arg ("mod", args(0));
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	657 else if (! args(1).is_numeric_type ())
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	658 gripe_wrong_type_arg ("mod", args(1));
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	659 else if (args(0).is_complex_type () \|\| args(1).is_complex_type ())
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	660 error ("mod: not defined for complex numbers");
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	661 else if (args(0).is_integer_type () \|\| args(1).is_integer_type ())
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	662 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	663 builtin_type_t btyp0 = args(0).builtin_type ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	664 builtin_type_t btyp1 = args(1).builtin_type ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	665 if (btyp0 == btyp_double \|\| btyp0 == btyp_float)
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	666 btyp0 = btyp1;
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	667 if (btyp1 == btyp_double \|\| btyp1 == btyp_float)
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	668 btyp1 = btyp0;
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	669
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	670 if (btyp0 == btyp1)
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	671 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	672 switch (btyp0)
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	673 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	674 #define MAKE_INT_BRANCH(X) \
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	675 case btyp_ ## X: \
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	676 { \
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	677 X##NDArray a0 = args(0).X##_array_value (); \
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	678 X##NDArray a1 = args(1).X##_array_value (); \
10682 7b4ffe27bbb4 Specify template arguments explicitely [MSVC]. Michael Goffioul <michael.goffioul@gmail.com> parents: 10538 diff changeset	679 retval = binmap<octave_##X,octave_##X,octave_##X> (a0, a1, mod, "mod"); \
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	680 } \
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	681 break
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	682 MAKE_INT_BRANCH (int8);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	683 MAKE_INT_BRANCH (int16);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	684 MAKE_INT_BRANCH (int32);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	685 MAKE_INT_BRANCH (int64);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	686 MAKE_INT_BRANCH (uint8);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	687 MAKE_INT_BRANCH (uint16);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	688 MAKE_INT_BRANCH (uint32);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	689 MAKE_INT_BRANCH (uint64);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	690 #undef MAKE_INT_BRANCH
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	691 default:
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	692 panic_impossible ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	693 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	694 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	695 else
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	696 error ("mod: cannot combine %s and %d",
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	697 args(0).class_name ().c_str (), args(1).class_name ().c_str ());
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	698 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	699 else if (args(0).is_single_type () \|\| args(1).is_single_type ())
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	700 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	701 if (args(0).is_scalar_type () && args(1).is_scalar_type ())
11209 94d9d412a2a0 improve Matlab compatibility of rem and mod John W. Eaton <jwe@octave.org> parents: 10983 diff changeset	702 retval = xmod (args(0).float_value (), args(1).float_value ());
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	703 else
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	704 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	705 FloatNDArray a0 = args(0).float_array_value ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	706 FloatNDArray a1 = args(1).float_array_value ();
11209 94d9d412a2a0 improve Matlab compatibility of rem and mod John W. Eaton <jwe@octave.org> parents: 10983 diff changeset	707 retval = binmap<float> (a0, a1, xmod, "mod");
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	708 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	709 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	710 else
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	711 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	712 bool a0_scalar = args(0).is_scalar_type ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	713 bool a1_scalar = args(1).is_scalar_type ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	714 if (a0_scalar && a1_scalar)
11209 94d9d412a2a0 improve Matlab compatibility of rem and mod John W. Eaton <jwe@octave.org> parents: 10983 diff changeset	715 retval = xmod (args(0).scalar_value (), args(1).scalar_value ());
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	716 else if ((a0_scalar \|\| args(0).is_sparse_type ())
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	717 && (a1_scalar \|\| args(1).is_sparse_type ()))
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	718 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	719 SparseMatrix m0 = args(0).sparse_matrix_value ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	720 SparseMatrix m1 = args(1).sparse_matrix_value ();
11209 94d9d412a2a0 improve Matlab compatibility of rem and mod John W. Eaton <jwe@octave.org> parents: 10983 diff changeset	721 retval = binmap<double> (m0, m1, xmod, "mod");
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	722 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	723 else
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	724 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	725 NDArray a0 = args(0).array_value ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	726 NDArray a1 = args(1).array_value ();
11209 94d9d412a2a0 improve Matlab compatibility of rem and mod John W. Eaton <jwe@octave.org> parents: 10983 diff changeset	727 retval = binmap<double> (a0, a1, xmod, "mod");
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	728 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	729 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	730 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	731 else
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	732 print_usage ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	733
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	734 return retval;
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	735 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	736
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	737 /*
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	738 ## empty input test
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	739 %!assert (isempty(mod([], [])));
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	740
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	741 ## x mod y, y != 0 tests
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	742 %!assert (mod(5, 3), 2);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	743 %!assert (mod(-5, 3), 1);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	744 %!assert (mod(0, 3), 0);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	745 %!assert (mod([-5, 5, 0], [3, 3, 3]), [1, 2, 0]);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	746 %!assert (mod([-5; 5; 0], [3; 3; 3]), [1; 2; 0]);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	747 %!assert (mod([-5, 5; 0, 3], [3, 3 ; 3, 1]), [1, 2 ; 0, 0]);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	748
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	749 ## x mod 0 tests
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	750 %!assert (mod(5, 0), 5);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	751 %!assert (mod(-5, 0), -5);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	752 %!assert (mod([-5, 5, 0], [3, 0, 3]), [1, 5, 0]);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	753 %!assert (mod([-5; 5; 0], [3; 0; 3]), [1; 5; 0]);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	754 %!assert (mod([-5, 5; 0, 3], [3, 0 ; 3, 1]), [1, 5 ; 0, 0]);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	755 %!assert (mod([-5, 5; 0, 3], [0, 0 ; 0, 0]), [-5, 5; 0, 3]);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	756
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	757 ## mixed scalar/matrix tests
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	758 %!assert (mod([-5, 5; 0, 3], 0), [-5, 5; 0, 3]);
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	759 %!assert (mod([-5, 5; 0, 3], 3), [1, 2; 0, 0]);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	760 %!assert (mod(-5,[0,0; 0,0]), [-5, -5; -5, -5]);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	761 %!assert (mod(-5,[3,0; 3,1]), [1, -5; 1, 0]);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	762 %!assert (mod(-5,[3,2; 3,1]), [1, 1; 1, 0]);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	763
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	764 ## integer types
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	765 %!assert (mod(uint8(5),uint8(4)),uint8(1))
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	766 %!assert (mod(uint8([1:5]),uint8(4)),uint8([1,2,3,0,1]))
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	767 %!assert (mod(uint8([1:5]),uint8(0)),uint8([1:5]))
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	768 %!error (mod(uint8(5),int8(4)))
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	769
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	770 ## mixed integer/real types
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	771 %!assert (mod(uint8(5),4),uint8(1))
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	772 %!assert (mod(5,uint8(4)),uint8(1))
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	773 %!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	774
903c1a3df301 Add additional tests for mod with non-integer real values. Rik <octave@nomad.inbox5.com> parents: 11242 diff changeset	775 ## non-integer real numbers
903c1a3df301 Add additional tests for mod with non-integer real values. Rik <octave@nomad.inbox5.com> parents: 11242 diff changeset	776 %!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	777 %!assert (mod (2.1, 0.2), 0.1, eps)
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	778 */
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	779
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	780 // FIXME Need to convert the reduction functions of this file for single precision
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	781
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	782 #define NATIVE_REDUCTION_1(FCN, TYPE, DIM) \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	783 (arg.is_ ## TYPE ## _type ()) \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	784 { \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	785 TYPE ## NDArray tmp = arg. TYPE ##_array_value (); \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	786 \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	787 if (! error_state) \
8780 ea76466605ba support native cumsum, gripe on overflow in sum/cumsum Jaroslav Hajek <highegg@gmail.com> parents: 8756 diff changeset	788 { \
ea76466605ba support native cumsum, gripe on overflow in sum/cumsum Jaroslav Hajek <highegg@gmail.com> parents: 8756 diff changeset	789 retval = tmp.FCN (DIM); \
ea76466605ba support native cumsum, gripe on overflow in sum/cumsum Jaroslav Hajek <highegg@gmail.com> parents: 8756 diff changeset	790 } \
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	791 }
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	792
8780 ea76466605ba support native cumsum, gripe on overflow in sum/cumsum Jaroslav Hajek <highegg@gmail.com> parents: 8756 diff changeset	793 #define NATIVE_REDUCTION(FCN, BOOL_FCN) \
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	794 \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	795 octave_value retval; \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	796 \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	797 int nargin = args.length (); \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	798 \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	799 bool isnative = false; \
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	800 bool isdouble = false; \
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	801 \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	802 if (nargin > 1 && args(nargin - 1).is_string ()) \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	803 { \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	804 std::string str = args(nargin - 1).string_value (); \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	805 \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	806 if (! error_state) \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	807 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	808 if (str == "native") \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	809 isnative = true; \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	810 else if (str == "double") \
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	811 isdouble = true; \
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	812 else \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	813 error ("sum: unrecognized string argument"); \
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	814 nargin --; \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	815 } \
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	816 } \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	817 \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	818 if (nargin == 1 \|\| nargin == 2) \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	819 { \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	820 octave_value arg = args(0); \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	821 \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	822 int dim = (nargin == 1 ? -1 : args(1).int_value (true) - 1); \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	823 \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	824 if (! error_state) \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	825 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	826 if (dim >= -1) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	827 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	828 if (arg.is_sparse_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	829 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	830 if (arg.is_real_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	831 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	832 SparseMatrix tmp = arg.sparse_matrix_value (); \
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7506 diff changeset	833 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	834 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	835 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	836 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	837 else \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	838 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	839 SparseComplexMatrix tmp = arg.sparse_complex_matrix_value (); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	840 \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	841 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	842 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	843 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	844 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	845 else \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	846 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	847 if (isnative) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	848 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	849 if NATIVE_REDUCTION_1 (FCN, uint8, dim) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	850 else if NATIVE_REDUCTION_1 (FCN, uint16, dim) \
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7506 diff changeset	851 else if NATIVE_REDUCTION_1 (FCN, uint32, dim) \
f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7506 diff changeset	852 else if NATIVE_REDUCTION_1 (FCN, uint64, dim) \
f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7506 diff changeset	853 else if NATIVE_REDUCTION_1 (FCN, int8, dim) \
f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7506 diff changeset	854 else if NATIVE_REDUCTION_1 (FCN, int16, dim) \
f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7506 diff changeset	855 else if NATIVE_REDUCTION_1 (FCN, int32, dim) \
f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7506 diff changeset	856 else if NATIVE_REDUCTION_1 (FCN, int64, dim) \
8756 d0755c9db5ed implement fast logical sum (counting) Jaroslav Hajek <highegg@gmail.com> parents: 8734 diff changeset	857 else if (arg.is_bool_type ()) \
d0755c9db5ed implement fast logical sum (counting) Jaroslav Hajek <highegg@gmail.com> parents: 8734 diff changeset	858 { \
8780 ea76466605ba support native cumsum, gripe on overflow in sum/cumsum Jaroslav Hajek <highegg@gmail.com> parents: 8756 diff changeset	859 boolNDArray tmp = arg.bool_array_value (); \
8756 d0755c9db5ed implement fast logical sum (counting) Jaroslav Hajek <highegg@gmail.com> parents: 8734 diff changeset	860 if (! error_state) \
8780 ea76466605ba support native cumsum, gripe on overflow in sum/cumsum Jaroslav Hajek <highegg@gmail.com> parents: 8756 diff changeset	861 retval = boolNDArray (tmp.BOOL_FCN (dim)); \
8756 d0755c9db5ed implement fast logical sum (counting) Jaroslav Hajek <highegg@gmail.com> parents: 8734 diff changeset	862 } \
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7506 diff changeset	863 else if (arg.is_char_matrix ()) \
f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7506 diff changeset	864 { \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	865 error (#FCN, ": invalid char type"); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	866 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	867 else if (!isdouble && arg.is_single_type ()) \
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	868 { \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	869 if (arg.is_complex_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	870 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	871 FloatComplexNDArray tmp = \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	872 arg.float_complex_array_value (); \
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	873 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	874 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	875 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	876 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	877 else if (arg.is_real_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	878 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	879 FloatNDArray tmp = arg.float_array_value (); \
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	880 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	881 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	882 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	883 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	884 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	885 else if (arg.is_complex_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	886 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	887 ComplexNDArray tmp = arg.complex_array_value (); \
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7506 diff changeset	888 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	889 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	890 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	891 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	892 else if (arg.is_real_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	893 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	894 NDArray tmp = arg.array_value (); \
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7506 diff changeset	895 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	896 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	897 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	898 } \
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7506 diff changeset	899 else \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	900 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	901 gripe_wrong_type_arg (#FCN, arg); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	902 return retval; \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	903 } \
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	904 } \
8756 d0755c9db5ed implement fast logical sum (counting) Jaroslav Hajek <highegg@gmail.com> parents: 8734 diff changeset	905 else if (arg.is_bool_type ()) \
d0755c9db5ed implement fast logical sum (counting) Jaroslav Hajek <highegg@gmail.com> parents: 8734 diff changeset	906 { \
d0755c9db5ed implement fast logical sum (counting) Jaroslav Hajek <highegg@gmail.com> parents: 8734 diff changeset	907 boolNDArray tmp = arg.bool_array_value (); \
d0755c9db5ed implement fast logical sum (counting) Jaroslav Hajek <highegg@gmail.com> parents: 8734 diff changeset	908 if (! error_state) \
d0755c9db5ed implement fast logical sum (counting) Jaroslav Hajek <highegg@gmail.com> parents: 8734 diff changeset	909 retval = tmp.FCN (dim); \
d0755c9db5ed implement fast logical sum (counting) Jaroslav Hajek <highegg@gmail.com> parents: 8734 diff changeset	910 } \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	911 else if (!isdouble && arg.is_single_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	912 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	913 if (arg.is_real_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	914 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	915 FloatNDArray tmp = arg.float_array_value (); \
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	916 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	917 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	918 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	919 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	920 else if (arg.is_complex_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	921 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	922 FloatComplexNDArray tmp = \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	923 arg.float_complex_array_value (); \
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	924 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	925 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	926 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	927 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	928 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	929 else if (arg.is_real_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	930 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	931 NDArray tmp = arg.array_value (); \
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7506 diff changeset	932 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	933 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	934 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	935 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	936 else if (arg.is_complex_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	937 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	938 ComplexNDArray tmp = arg.complex_array_value (); \
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	939 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	940 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	941 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	942 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	943 else \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	944 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	945 gripe_wrong_type_arg (#FCN, arg); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	946 return retval; \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	947 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	948 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	949 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	950 else \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	951 error (#FCN ": invalid dimension argument = %d", dim + 1); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	952 } \
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	953 \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	954 } \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	955 else \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	956 print_usage (); \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	957 \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	958 return retval
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	959
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	960 #define DATA_REDUCTION(FCN) \
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	961 \
4233 ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe] jwe parents: 4176 diff changeset	962 octave_value retval; \
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	963 \
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	964 int nargin = args.length (); \
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	965 \
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	966 if (nargin == 1 \|\| nargin == 2) \
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	967 { \
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	968 octave_value arg = args(0); \
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	969 \
3864 e78705239df5 [project @ 2001-11-16 12:56:20 by jwe] jwe parents: 3797 diff changeset	970 int dim = (nargin == 1 ? -1 : args(1).int_value (true) - 1); \
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	971 \
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	972 if (! error_state) \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	973 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	974 if (dim >= -1) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	975 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	976 if (arg.is_real_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	977 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	978 if (arg.is_sparse_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	979 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	980 SparseMatrix tmp = arg.sparse_matrix_value (); \
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	981 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	982 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	983 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	984 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	985 else if (arg.is_single_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	986 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	987 FloatNDArray tmp = arg.float_array_value (); \
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	988 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	989 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	990 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	991 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	992 else \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	993 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	994 NDArray tmp = arg.array_value (); \
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7506 diff changeset	995 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	996 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	997 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	998 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	999 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1000 else if (arg.is_complex_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1001 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1002 if (arg.is_sparse_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1003 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1004 SparseComplexMatrix tmp = arg.sparse_complex_matrix_value (); \
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1005 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1006 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1007 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1008 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1009 else if (arg.is_single_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1010 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1011 FloatComplexNDArray tmp = arg.float_complex_array_value (); \
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	1012 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1013 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1014 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1015 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1016 else \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1017 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1018 ComplexNDArray tmp = arg.complex_array_value (); \
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7506 diff changeset	1019 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1020 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1021 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1022 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1023 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1024 else \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1025 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1026 gripe_wrong_type_arg (#FCN, arg); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1027 return retval; \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1028 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1029 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1030 else \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1031 error (#FCN ": invalid dimension argument = %d", dim + 1); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1032 } \
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1033 } \
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1034 else \
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	1035 print_usage (); \
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1036 \
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1037 return retval
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1038
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	1039 DEFUN (cumprod, args, ,
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	1040 "-- texinfo --\n\
9163 9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	1041 @deftypefn {Built-in Function} {} cumprod (@var{x})\n\
9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	1042 @deftypefnx {Built-in Function} {} cumprod (@var{x}, @var{dim})\n\
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1043 Cumulative product of elements along dimension @var{dim}. If\n\
9723 f426899f4b9c fix reduction functions docstrings Jaroslav Hajek <highegg@gmail.com> parents: 9721 diff changeset	1044 @var{dim} is omitted, it defaults to the first non-singleton dimension.\n\
5061 4689ee5e88ec [project @ 2004-11-03 21:23:42 by jwe] jwe parents: 5058 diff changeset	1045 \n\
9163 9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	1046 @seealso{prod, cumsum}\n\
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	1047 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1048 {
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1049 DATA_REDUCTION (cumprod);
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1050 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1051
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1052 /*
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1053
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1054 %!assert (cumprod ([1, 2, 3]), [1, 2, 6]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1055 %!assert (cumprod ([-1; -2; -3]), [-1; 2; -6]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1056 %!assert (cumprod ([i, 2+i, -3+2i, 4]), [i, -1+2i, -1-8i, -4-32i]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1057 %!assert (cumprod ([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i]), [1, 2, 3; i, 4i, 9i; -1+i, -8+8i, -27+27i]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1058
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1059 %!assert (cumprod (single([1, 2, 3])), single([1, 2, 6]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1060 %!assert (cumprod (single([-1; -2; -3])), single([-1; 2; -6]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1061 %!assert (cumprod (single([i, 2+i, -3+2i, 4])), single([i, -1+2i, -1-8i, -4-32i]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1062 %!assert (cumprod (single([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i])), single([1, 2, 3; i, 4i, 9i; -1+i, -8+8i, -27+27i]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1063
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1064 %!error <Invalid call to cumprod.*> cumprod ();
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1065
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1066 %!assert (cumprod ([2, 3; 4, 5], 1), [2, 3; 8, 15]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1067 %!assert (cumprod ([2, 3; 4, 5], 2), [2, 6; 4, 20]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1068
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1069 %!assert (cumprod (single([2, 3; 4, 5]), 1), single([2, 3; 8, 15]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1070 %!assert (cumprod (single([2, 3; 4, 5]), 2), single([2, 6; 4, 20]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1071
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1072 */
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1073
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	1074 DEFUN (cumsum, args, ,
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	1075 "-- texinfo --\n\
9163 9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	1076 @deftypefn {Built-in Function} {} cumsum (@var{x})\n\
9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	1077 @deftypefnx {Built-in Function} {} cumsum (@var{x}, @var{dim})\n\
8780 ea76466605ba support native cumsum, gripe on overflow in sum/cumsum Jaroslav Hajek <highegg@gmail.com> parents: 8756 diff changeset	1078 @deftypefnx {Built-in Function} {} cumsum (@dots{}, 'native')\n\
12546 39ca02387a32 Improve docstrings for a number of functions. Rik <octave@nomad.inbox5.com> parents: 12483 diff changeset	1079 @deftypefnx {Built-in Function} {} cumsum (@dots{}, 'double')\n\
39ca02387a32 Improve docstrings for a number of functions. Rik <octave@nomad.inbox5.com> parents: 12483 diff changeset	1080 @deftypefnx {Built-in Function} {} cumsum (@dots{}, 'extra')\n\
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1081 Cumulative sum of elements along dimension @var{dim}. If @var{dim}\n\
9723 f426899f4b9c fix reduction functions docstrings Jaroslav Hajek <highegg@gmail.com> parents: 9721 diff changeset	1082 is omitted, it defaults to the first non-singleton dimension.\n\
8780 ea76466605ba support native cumsum, gripe on overflow in sum/cumsum Jaroslav Hajek <highegg@gmail.com> parents: 8756 diff changeset	1083 \n\
12546 39ca02387a32 Improve docstrings for a number of functions. Rik <octave@nomad.inbox5.com> parents: 12483 diff changeset	1084 See @code{sum} for an explanation of the optional parameters 'native',\n\
39ca02387a32 Improve docstrings for a number of functions. Rik <octave@nomad.inbox5.com> parents: 12483 diff changeset	1085 'double', and 'extra'.\n\
9163 9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	1086 @seealso{sum, cumprod}\n\
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	1087 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1088 {
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1089 octave_value retval;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1090
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1091 int nargin = args.length ();
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1092
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1093 bool isnative = false;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1094 bool isdouble = false;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1095
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1096 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	1097 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1098 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	1099
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1100 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1101 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1102 if (str == "native")
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1103 isnative = true;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1104 else if (str == "double")
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1105 isdouble = true;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1106 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1107 error ("sum: unrecognized string argument");
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1108 nargin --;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1109 }
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1110 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1111
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1112 if (error_state)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1113 return retval;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1114
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1115 if (nargin == 1 \|\| nargin == 2)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1116 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1117 octave_value arg = args(0);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1118
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1119 int dim = -1;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1120 if (nargin == 2)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1121 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1122 dim = args(1).int_value () - 1;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1123 if (dim < 0)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1124 error ("cumsum: invalid dimension argument = %d", dim + 1);
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1125 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1126
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1127 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1128 {
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1129 switch (arg.builtin_type ())
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1130 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1131 case btyp_double:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1132 if (arg.is_sparse_type ())
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1133 retval = arg.sparse_matrix_value ().cumsum (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1134 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1135 retval = arg.array_value ().cumsum (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1136 break;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1137 case btyp_complex:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1138 if (arg.is_sparse_type ())
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1139 retval = arg.sparse_complex_matrix_value ().cumsum (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1140 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1141 retval = arg.complex_array_value ().cumsum (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1142 break;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1143 case btyp_float:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1144 if (isdouble)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1145 retval = arg.array_value ().cumsum (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1146 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1147 retval = arg.float_array_value ().cumsum (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1148 break;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1149 case btyp_float_complex:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1150 if (isdouble)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1151 retval = arg.complex_array_value ().cumsum (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1152 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1153 retval = arg.float_complex_array_value ().cumsum (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1154 break;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1155
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1156 #define MAKE_INT_BRANCH(X) \
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1157 case btyp_ ## X: \
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1158 if (isnative) \
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1159 retval = arg.X ## _array_value ().cumsum (dim); \
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1160 else \
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1161 retval = arg.array_value ().cumsum (dim); \
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1162 break
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1163 MAKE_INT_BRANCH (int8);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1164 MAKE_INT_BRANCH (int16);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1165 MAKE_INT_BRANCH (int32);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1166 MAKE_INT_BRANCH (int64);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1167 MAKE_INT_BRANCH (uint8);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1168 MAKE_INT_BRANCH (uint16);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1169 MAKE_INT_BRANCH (uint32);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1170 MAKE_INT_BRANCH (uint64);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1171 #undef MAKE_INT_BRANCH
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1172
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1173 case btyp_bool:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1174 if (arg.is_sparse_type ())
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1175 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1176 SparseMatrix cs = arg.sparse_matrix_value ().cumsum (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1177 if (isnative)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1178 retval = cs != 0.0;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1179 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1180 retval = cs;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1181 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1182 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1183 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1184 NDArray cs = arg.bool_array_value ().cumsum (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1185 if (isnative)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1186 retval = cs != 0.0;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1187 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1188 retval = cs;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1189 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1190 break;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1191
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1192 default:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1193 gripe_wrong_type_arg ("cumsum", arg);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1194 }
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1195 }
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1196 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1197 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1198 print_usage ();
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 /*
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1204
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1205 %!assert (cumsum ([1, 2, 3]), [1, 3, 6]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1206 %!assert (cumsum ([-1; -2; -3]), [-1; -3; -6]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1207 %!assert (cumsum ([i, 2+i, -3+2i, 4]), [i, 2+2i, -1+4i, 3+4i]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1208 %!assert (cumsum ([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i]), [1, 2, 3; 1+i, 2+2i, 3+3i; 2+2i, 4+4i, 6+6i]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1209
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1210 %!assert (cumsum (single([1, 2, 3])), single([1, 3, 6]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1211 %!assert (cumsum (single([-1; -2; -3])), single([-1; -3; -6]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1212 %!assert (cumsum (single([i, 2+i, -3+2i, 4])), single([i, 2+2i, -1+4i, 3+4i]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1213 %!assert (cumsum (single([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i])), single([1, 2, 3; 1+i, 2+2i, 3+3i; 2+2i, 4+4i, 6+6i]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1214
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1215 %!error <Invalid call to cumsum.*> cumsum ();
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1216
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1217 %!assert (cumsum ([1, 2; 3, 4], 1), [1, 2; 4, 6]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1218 %!assert (cumsum ([1, 2; 3, 4], 2), [1, 3; 3, 7]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1219
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1220 %!assert (cumsum (single([1, 2; 3, 4]), 1), single([1, 2; 4, 6]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1221 %!assert (cumsum (single([1, 2; 3, 4]), 2), single([1, 3; 3, 7]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1222
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1223 */
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1224
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	1225 DEFUN (diag, args, ,
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	1226 "-- texinfo --\n\
12567 cc8ccdfec424 Remove archaic 3-input argument form of diag function. Rik <octave@nomad.inbox5.com> parents: 12546 diff changeset	1227 @deftypefn {Built-in Function} {@var{M} =} diag (@var{v})\n\
cc8ccdfec424 Remove archaic 3-input argument form of diag function. Rik <octave@nomad.inbox5.com> parents: 12546 diff changeset	1228 @deftypefnx {Built-in Function} {@var{M} =} diag (@var{v}, @var{k})\n\
cc8ccdfec424 Remove archaic 3-input argument form of diag function. Rik <octave@nomad.inbox5.com> parents: 12546 diff changeset	1229 @deftypefnx {Built-in Function} {@var{v} =} diag (@var{M})\n\
cc8ccdfec424 Remove archaic 3-input argument form of diag function. Rik <octave@nomad.inbox5.com> parents: 12546 diff changeset	1230 @deftypefnx {Built-in Function} {@var{v} =} diag (@var{M}, @var{k})\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	1231 Return a diagonal matrix with vector @var{v} on diagonal @var{k}. The\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	1232 second argument is optional. If it is positive, the vector is placed on\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	1233 the @var{k}-th super-diagonal. If it is negative, it is placed on the\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	1234 @var{-k}-th sub-diagonal. The default value of @var{k} is 0, and the\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	1235 vector is placed on the main diagonal. For example:\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	1236 \n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	1237 @example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	1238 @group\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	1239 diag ([1, 2, 3], 1)\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	1240 @result{} 0 1 0 0\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	1241 0 0 2 0\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	1242 0 0 0 3\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	1243 0 0 0 0\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	1244 @end group\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	1245 @end example\n\
6772 315bc7c8f9b5 [project @ 2007-07-10 09:51:39 by dbateman] dbateman parents: 6688 diff changeset	1246 \n\
315bc7c8f9b5 [project @ 2007-07-10 09:51:39 by dbateman] dbateman parents: 6688 diff changeset	1247 @noindent\n\
315bc7c8f9b5 [project @ 2007-07-10 09:51:39 by dbateman] dbateman parents: 6688 diff changeset	1248 Given a matrix argument, instead of a vector, @code{diag} extracts the\n\
6774 3b09c87d5165 [project @ 2007-07-13 13:27:36 by dbateman] dbateman parents: 6772 diff changeset	1249 @var{k}-th diagonal of the matrix.\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	1250 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1251 {
4233 ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe] jwe parents: 4176 diff changeset	1252 octave_value retval;
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1253
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1254 int nargin = args.length ();
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1255
712 36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	1256 if (nargin == 1 && args(0).is_defined ())
7620 36594d5bbe13 Move diag function into the octave_value class David Bateman <dbateman@free.fr> parents: 7618 diff changeset	1257 retval = args(0).diag();
712 36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	1258 else if (nargin == 2 && args(0).is_defined () && args(1).is_defined ())
7620 36594d5bbe13 Move diag function into the octave_value class David Bateman <dbateman@free.fr> parents: 7618 diff changeset	1259 {
36594d5bbe13 Move diag function into the octave_value class David Bateman <dbateman@free.fr> parents: 7618 diff changeset	1260 octave_idx_type k = args(1).int_value ();
36594d5bbe13 Move diag function into the octave_value class David Bateman <dbateman@free.fr> parents: 7618 diff changeset	1261
36594d5bbe13 Move diag function into the octave_value class David Bateman <dbateman@free.fr> parents: 7618 diff changeset	1262 if (error_state)
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	1263 error ("diag: invalid argument K");
7620 36594d5bbe13 Move diag function into the octave_value class David Bateman <dbateman@free.fr> parents: 7618 diff changeset	1264 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1265 retval = args(0).diag(k);
7620 36594d5bbe13 Move diag function into the octave_value class David Bateman <dbateman@free.fr> parents: 7618 diff changeset	1266 }
12570 1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1267 else if (nargin == 3)
1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1268 {
1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1269 octave_value arg0 = args(0);
1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1270 if (arg0.ndims () == 2 && (args(0).rows () == 1 \|\| args(0).columns () == 1))
1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1271 {
1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1272 octave_idx_type m = args(1).int_value (), n = args(2).int_value ();
1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1273 if (! error_state)
1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1274 retval = arg0.diag ().resize (dim_vector (m, n));
1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1275 else
1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1276 error ("diag: invalid dimensions");
1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1277 }
1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1278 else
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");
1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1280 }
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1281 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	1282 print_usage ();
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1283
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1284 return retval;
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1285 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1286
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1287 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1288
8459 d17874a6f161 improve indexing of diagonal & permutation matrices Jaroslav Hajek <highegg@gmail.com> parents: 8458 diff changeset	1289 %!assert(full (diag ([1; 2; 3])), [1, 0, 0; 0, 2, 0; 0, 0, 3]);
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1290 %!assert(diag ([1; 2; 3], 1), [0, 1, 0, 0; 0, 0, 2, 0; 0, 0, 0, 3; 0, 0, 0, 0]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1291 %!assert(diag ([1; 2; 3], 2), [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]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1292 %!assert(diag ([1; 2; 3],-1), [0, 0, 0, 0; 1, 0, 0, 0; 0, 2, 0, 0; 0, 0, 3, 0]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1293 %!assert(diag ([1; 2; 3],-2), [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]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1294
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1295 %!assert(diag ([1, 0, 0; 0, 2, 0; 0, 0, 3]), [1; 2; 3]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1296 %!assert(diag ([0, 1, 0, 0; 0, 0, 2, 0; 0, 0, 0, 3; 0, 0, 0, 0], 1), [1; 2; 3]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1297 %!assert(diag ([0, 0, 0, 0; 1, 0, 0, 0; 0, 2, 0, 0; 0, 0, 3, 0], -1), [1; 2; 3]);
12567 cc8ccdfec424 Remove archaic 3-input argument form of diag function. Rik <octave@nomad.inbox5.com> parents: 12546 diff changeset	1298 %!assert(diag (ones(1, 0), 2), zeros (2));
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1299
8459 d17874a6f161 improve indexing of diagonal & permutation matrices Jaroslav Hajek <highegg@gmail.com> parents: 8458 diff changeset	1300 %!assert(full (diag (single([1; 2; 3]))), single([1, 0, 0; 0, 2, 0; 0, 0, 3]));
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1301 %!assert(diag (single([1; 2; 3]), 1), single([0, 1, 0, 0; 0, 0, 2, 0; 0, 0, 0, 3; 0, 0, 0, 0]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1302 %!assert(diag (single([1; 2; 3]), 2), 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]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1303 %!assert(diag (single([1; 2; 3]),-1), single([0, 0, 0, 0; 1, 0, 0, 0; 0, 2, 0, 0; 0, 0, 3, 0]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1304 %!assert(diag (single([1; 2; 3]),-2), 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]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1305
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1306 %!assert(diag (single([1, 0, 0; 0, 2, 0; 0, 0, 3])), single([1; 2; 3]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1307 %!assert(diag (single([0, 1, 0, 0; 0, 0, 2, 0; 0, 0, 0, 3; 0, 0, 0, 0]), 1), single([1; 2; 3]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1308 %!assert(diag (single([0, 0, 0, 0; 1, 0, 0, 0; 0, 2, 0, 0; 0, 0, 3, 0]), -1), single([1; 2; 3]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1309
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1310 %!assert(diag (int8([1; 2; 3])), int8([1, 0, 0; 0, 2, 0; 0, 0, 3]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1311 %!assert(diag (int8([1; 2; 3]), 1), int8([0, 1, 0, 0; 0, 0, 2, 0; 0, 0, 0, 3; 0, 0, 0, 0]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1312 %!assert(diag (int8([1; 2; 3]), 2), 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]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1313 %!assert(diag (int8([1; 2; 3]),-1), int8([0, 0, 0, 0; 1, 0, 0, 0; 0, 2, 0, 0; 0, 0, 3, 0]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1314 %!assert(diag (int8([1; 2; 3]),-2), 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]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1315
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1316 %!assert(diag (int8([1, 0, 0; 0, 2, 0; 0, 0, 3])), int8([1; 2; 3]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1317 %!assert(diag (int8([0, 1, 0, 0; 0, 0, 2, 0; 0, 0, 0, 3; 0, 0, 0, 0]), 1), int8([1; 2; 3]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1318 %!assert(diag (int8([0, 0, 0, 0; 1, 0, 0, 0; 0, 2, 0, 0; 0, 0, 3, 0]), -1), int8([1; 2; 3]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1319
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1320 %!error <Invalid call to diag.*> diag ();
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1321
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1322 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1323
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	1324 DEFUN (prod, args, ,
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	1325 "-- texinfo --\n\
9163 9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	1326 @deftypefn {Built-in Function} {} prod (@var{x})\n\
9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	1327 @deftypefnx {Built-in Function} {} prod (@var{x}, @var{dim})\n\
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1328 Product of elements along dimension @var{dim}. If @var{dim} is\n\
9723 f426899f4b9c fix reduction functions docstrings Jaroslav Hajek <highegg@gmail.com> parents: 9721 diff changeset	1329 omitted, it defaults to the first non-singleton dimension.\n\
9163 9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	1330 @seealso{cumprod, sum}\n\
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	1331 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1332 {
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1333 DATA_REDUCTION (prod);
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1334 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1335
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1336 /*
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1337
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1338 %!assert (prod ([1, 2, 3]), 6);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1339 %!assert (prod ([-1; -2; -3]), -6);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1340 %!assert (prod ([i, 2+i, -3+2i, 4]), -4 - 32i);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1341 %!assert (prod ([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i]), [-1+i, -8+8i, -27+27i]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1342
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1343 %!assert (prod (single([1, 2, 3])), single(6));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1344 %!assert (prod (single([-1; -2; -3])), single(-6));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1345 %!assert (prod (single([i, 2+i, -3+2i, 4])), single(-4 - 32i));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1346 %!assert (prod (single([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i])), single([-1+i, -8+8i, -27+27i]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1347
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1348 %!error <Invalid call to prod.*> prod ();
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1349
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1350 %!assert (prod ([1, 2; 3, 4], 1), [3, 8]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1351 %!assert (prod ([1, 2; 3, 4], 2), [2; 12]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1352 %!assert (prod (zeros (1, 0)), 1);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1353 %!assert (prod (zeros (1, 0), 1), zeros (1, 0));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1354 %!assert (prod (zeros (1, 0), 2), 1);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1355 %!assert (prod (zeros (0, 1)), 1);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1356 %!assert (prod (zeros (0, 1), 1), 1);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1357 %!assert (prod (zeros (0, 1), 2), zeros (0, 1));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1358 %!assert (prod (zeros (2, 0)), zeros (1, 0));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1359 %!assert (prod (zeros (2, 0), 1), zeros (1, 0));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1360 %!assert (prod (zeros (2, 0), 2), [1; 1]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1361 %!assert (prod (zeros (0, 2)), [1, 1]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1362 %!assert (prod (zeros (0, 2), 1), [1, 1]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1363 %!assert (prod (zeros (0, 2), 2), zeros(0, 1));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1364
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1365 %!assert (prod (single([1, 2; 3, 4]), 1), single([3, 8]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1366 %!assert (prod (single([1, 2; 3, 4]), 2), single([2; 12]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1367 %!assert (prod (zeros (1, 0, 'single')), single(1));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1368 %!assert (prod (zeros (1, 0, 'single'), 1), zeros (1, 0, 'single'));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1369 %!assert (prod (zeros (1, 0, 'single'), 2), single(1));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1370 %!assert (prod (zeros (0, 1, 'single')), single(1));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1371 %!assert (prod (zeros (0, 1, 'single'), 1), single(1));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1372 %!assert (prod (zeros (0, 1, 'single'), 2), zeros (0, 1, 'single'));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1373 %!assert (prod (zeros (2, 0, 'single')), zeros (1, 0, 'single'));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1374 %!assert (prod (zeros (2, 0, 'single'), 1), zeros (1, 0, 'single'));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1375 %!assert (prod (zeros (2, 0, 'single'), 2), single([1; 1]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1376 %!assert (prod (zeros (0, 2, 'single')), single([1, 1]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1377 %!assert (prod (zeros (0, 2, 'single'), 1), single([1, 1]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1378 %!assert (prod (zeros (0, 2, 'single'), 2), zeros(0, 1, 'single'));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1379
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1380 */
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1381
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1382 static bool
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1383 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	1384 {
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1385 int n_args = args.length ();
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1386 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	1387 if (args(i).numel () != 1)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1388 return false;
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1389
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1390 return true;
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1391 }
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1392
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1393 template <class TYPE, class T>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1394 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	1395 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	1396 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	1397 int dim)
f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1398 {
f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1399 int n_args = args.length ();
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1400 if (! (equal_types<T, char>::value
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1401 \|\| equal_types<T, octave_value>::value)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1402 && 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	1403 {
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1404 // Optimize all scalars case.
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1405 dim_vector dv (1, 1);
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1406 if (dim == -1 \|\| dim == -2)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1407 dim = -dim - 1;
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1408 else if (dim >= 2)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1409 dv.resize (dim+1, 1);
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1410 dv(dim) = n_args;
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1411
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1412 result.clear (dv);
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1413
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1414 for (int j = 0; j < n_args && ! error_state; j++)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1415 {
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1416 octave_quit ();
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1417
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1418 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	1419 }
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1420 }
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1421 else
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1422 {
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1423 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	1424
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1425 for (int j = 0; j < n_args && ! error_state; j++)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1426 {
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1427 octave_quit ();
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1428
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1429 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	1430 }
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1431
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1432 if (! error_state)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1433 result = Array<T>::cat (dim, n_args, array_list);
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1434 }
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1435 }
f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1436
f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1437 template <class TYPE, class T>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1438 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	1439 single_type_concat (Sparse<T>& result,
10498 8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1440 const octave_value_list& args,
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1441 int dim)
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1442 {
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1443 int 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	1444 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	1445
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1446 for (int j = 0; j < n_args && ! error_state; j++)
10498 8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1447 {
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1448 octave_quit ();
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1449
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1450 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	1451 }
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1452
f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1453 if (! error_state)
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1454 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	1455 }
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1456
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1457 // Dispatcher.
10498 8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1458 template<class TYPE>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1459 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	1460 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	1461 {
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1462 TYPE result;
f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1463
f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1464 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	1465
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1466 return result;
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1467 }
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1468
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1469 template<class MAP>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1470 static void
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1471 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	1472 const octave_value_list& args,
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1473 int dim)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1474 {
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1475 int n_args = args.length ();
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1476 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	1477
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1478 for (int j = 0; j < n_args && ! error_state; j++)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1479 {
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1480 octave_quit ();
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1481
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1482 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	1483 }
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1484
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1485 if (! error_state)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1486 result = octave_map::cat (dim, n_args, map_list);
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1487 }
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1488
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1489 static octave_map
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1490 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	1491 int dim)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1492 {
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1493 octave_map result;
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1494 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	1495 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	1496 else
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1497 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	1498
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1499 return result;
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1500 }
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1501
4824 4829055e154f [project @ 2004-03-08 18:16:04 by jwe] jwe parents: 4806 diff changeset	1502 static octave_value
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1503 do_cat (const octave_value_list& args, int dim, std::string fname)
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1504 {
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1505 octave_value retval;
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1506
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1507 int n_args = args.length ();
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1508
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1509 if (n_args == 0)
5714 24f6a13878c2 [project @ 2006-03-23 21:46:09 by jwe] jwe parents: 5677 diff changeset	1510 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	1511 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	1512 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	1513 else if (n_args > 1)
4824 4829055e154f [project @ 2004-03-08 18:16:04 by jwe] jwe parents: 4806 diff changeset	1514 {
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1515
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1516 std::string result_type = args(0).class_name ();
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1517
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1518 bool all_sq_strings_p = args(0).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	1519 bool all_dq_strings_p = args(0).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	1520 bool all_real_p = args(0).is_real_type ();
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1521 bool any_sparse_p = args(0).is_sparse_type();
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1522
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1523 for (int i = 1; i < args.length (); i++)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1524 {
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1525 result_type =
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1526 get_concat_class (result_type, args(i).class_name ());
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1527
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1528 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	1529 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	1530 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	1531 all_dq_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	1532 if (all_real_p && ! args(i).is_real_type ())
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1533 all_real_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	1534 if (!any_sparse_p && args(i).is_sparse_type ())
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1535 any_sparse_p = true;
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1536 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1537
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1538 if (result_type == "double")
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1539 {
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1540 if (any_sparse_p)
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1541 {
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1542 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	1543 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	1544 else
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1545 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	1546 }
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1547 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1548 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1549 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	1550 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	1551 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	1552 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	1553 }
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1554 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1555 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	1556 {
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1557 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	1558 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	1559 else
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1560 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	1561 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1562 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	1563 {
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1564 char type = all_dq_strings_p ? '"' : '\'';
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1565
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1566 maybe_warn_string_concat (all_dq_strings_p, all_sq_strings_p);
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1567
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1568 charNDArray result = do_single_type_concat<charNDArray> (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	1569
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1570 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	1571 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1572 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	1573 {
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1574 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	1575 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	1576 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	1577 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	1578 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1579 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	1580 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	1581 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	1582 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	1583 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	1584 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	1585 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	1586 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	1587 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	1588 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	1589 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	1590 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	1591 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	1592 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	1593 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	1594 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	1595 else if (result_type == "cell")
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1596 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	1597 else if (result_type == "struct")
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1598 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	1599 else
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1600 {
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1601 dim_vector dv = args(0).dims ();
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1602
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1603 // Default concatenation.
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1604 bool (dim_vector::*concat_rule) (const dim_vector&, int) = &dim_vector::concat;
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1605
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1606 if (dim == -1 \|\| dim == -2)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1607 {
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1608 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	1609 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	1610 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1611
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1612 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	1613 {
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1614 if (! (dv.*concat_rule) (args(i).dims (), dim))
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1615 {
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1616 // Dimensions do not match.
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1617 error ("cat: dimension mismatch");
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1618 return retval;
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1619 }
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1620 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1621
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1622 // 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	1623 // of the first argument, resize it to be empty and then resize
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1624 // it to be full. This is done since it means that there is no
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1625 // 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	1626 // 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	1627 // 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	1628 // 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	1629 //
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1630 // We might also start with a empty octave_value using
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1631 // tmp = octave_value_typeinfo::lookup_type
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1632 // (args(1).type_name());
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1633 // and then directly resize. However, for some types there might
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1634 // 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	1635
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1636 octave_value tmp = 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	1637 tmp = tmp.resize (dim_vector (0,0)).resize (dv);
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1638
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1639 if (error_state)
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1640 return retval;
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1641
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1642 int dv_len = dv.length ();
11570 57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	1643 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	1644
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1645 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	1646 {
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1647 // Can't fast return here to skip empty matrices as something
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1648 // like cat(1,[],single([])) must return an empty matrix of
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1649 // the right type.
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1650 tmp = do_cat_op (tmp, args (j), ra_idx);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1651
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1652 if (error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1653 return retval;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1654
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1655 dim_vector dv_tmp = args (j).dims ();
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1656
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1657 if (dim >= dv_len)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1658 {
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1659 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	1660 error ("%s: indexing error", fname.c_str ());
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1661 break;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1662 }
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1663 else
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1664 ra_idx (dim) += (dim < dv_tmp.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	1665 dv_tmp (dim) : 1);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1666 }
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1667 retval = tmp;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1668 }
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1669 }
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1670 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	1671 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	1672
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1673 return retval;
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1674 }
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1675
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1676 DEFUN (horzcat, args, ,
4824 4829055e154f [project @ 2004-03-08 18:16:04 by jwe] jwe parents: 4806 diff changeset	1677 "-- texinfo --\n\
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1678 @deftypefn {Built-in Function} {} horzcat (@var{array1}, @var{array2}, @dots{}, @var{arrayN})\n\
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1679 Return the horizontal concatenation of N-d array objects, @var{array1},\n\
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1680 @var{array2}, @dots{}, @var{arrayN} along dimension 2.\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5607 diff changeset	1681 @seealso{cat, vertcat}\n\
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5607 diff changeset	1682 @end deftypefn")
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1683 {
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1684 return do_cat (args, -2, "horzcat");
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1685 }
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1686
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1687 DEFUN (vertcat, args, ,
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1688 "-- texinfo --\n\
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1689 @deftypefn {Built-in Function} {} vertcat (@var{array1}, @var{array2}, @dots{}, @var{arrayN})\n\
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1690 Return the vertical concatenation of N-d array objects, @var{array1},\n\
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1691 @var{array2}, @dots{}, @var{arrayN} along dimension 1.\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5607 diff changeset	1692 @seealso{cat, horzcat}\n\
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5607 diff changeset	1693 @end deftypefn")
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1694 {
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1695 return do_cat (args, -1, "vertcat");
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1696 }
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1697
4758 a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1698 DEFUN (cat, args, ,
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1699 "-- texinfo --\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1700 @deftypefn {Built-in Function} {} cat (@var{dim}, @var{array1}, @var{array2}, @dots{}, @var{arrayN})\n\
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1701 Return the concatenation of N-d array objects, @var{array1},\n\
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1702 @var{array2}, @dots{}, @var{arrayN} along dimension @var{dim}.\n\
4758 a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1703 \n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1704 @example\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1705 @group\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1706 A = ones (2, 2);\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1707 B = zeros (2, 2);\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1708 cat (2, A, B)\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1709 @result{} ans =\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1710 \n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1711 1 1 0 0\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1712 1 1 0 0\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1713 @end group\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1714 @end example\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1715 \n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1716 Alternatively, we can concatenate @var{A} and @var{B} along the\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1717 second dimension the following way:\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1718 \n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1719 @example\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1720 @group\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1721 [A, B].\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1722 @end group\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1723 @end example\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1724 \n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1725 @var{dim} can be larger than the dimensions of the N-d array objects\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1726 and the result will thus have @var{dim} dimensions as the\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1727 following example shows:\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	1728 \n\
4758 a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1729 @example\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1730 @group\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1731 cat (4, ones(2, 2), zeros (2, 2))\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1732 @result{} ans =\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1733 \n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1734 ans(:,:,1,1) =\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1735 \n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1736 1 1\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1737 1 1\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1738 \n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1739 ans(:,:,1,2) =\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1740 0 0\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1741 0 0\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1742 @end group\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1743 @end example\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5607 diff changeset	1744 @seealso{horzcat, vertcat}\n\
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5607 diff changeset	1745 @end deftypefn")
4758 a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1746 {
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1747 octave_value retval;
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1748
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1749 if (args.length () > 0)
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1750 {
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1751 int dim = args(0).int_value () - 1;
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1752
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1753 if (! error_state)
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1754 {
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1755 if (dim >= 0)
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1756 retval = do_cat (args.slice (1, args.length () - 1), dim, "cat");
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1757 else
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	1758 error ("cat: DIM must be a valid dimension");
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1759 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1760 else
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	1761 error ("cat: DIM must be an integer");
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1762 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1763 else
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1764 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	1765
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1766 return retval;
4758 a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1767 }
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	1768
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1769 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1770
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1771 %!function ret = testcat (t1, t2, tr, cmplx)
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1772 %! assert (cat (1, cast ([], t1), cast([], t2)), cast ([], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1773 %!
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1774 %! assert (cat (1, cast (1, t1), cast (2, t2)), cast ([1; 2], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1775 %! assert (cat (1, cast (1, t1), cast ([2; 3], t2)), cast ([1; 2; 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1776 %! assert (cat (1, cast ([1; 2], t1), cast (3, t2)), cast ([1; 2; 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1777 %! assert (cat (1, cast ([1; 2], t1), cast ([3; 4], t2)), cast ([1; 2; 3; 4], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1778 %! assert (cat (2, cast (1, t1), cast (2, t2)), cast ([1, 2], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1779 %! assert (cat (2, cast (1, t1), cast ([2, 3], t2)), cast ([1, 2, 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1780 %! assert (cat (2, cast ([1, 2], t1), cast (3, t2)), cast ([1, 2, 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1781 %! assert (cat (2, cast ([1, 2], t1), cast ([3, 4], t2)), cast ([1, 2, 3, 4], tr));
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1782 %!
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1783 %! assert ([cast(1, t1); cast(2, t2)], cast ([1; 2], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1784 %! assert ([cast(1, t1); cast([2; 3], t2)], cast ([1; 2; 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1785 %! assert ([cast([1; 2], t1); cast(3, t2)], cast ([1; 2; 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1786 %! assert ([cast([1; 2], t1); cast([3; 4], t2)], cast ([1; 2; 3; 4], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1787 %! assert ([cast(1, t1), cast(2, t2)], cast ([1, 2], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1788 %! assert ([cast(1, t1), cast([2, 3], t2)], cast ([1, 2, 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1789 %! assert ([cast([1, 2], t1), cast(3, t2)], cast ([1, 2, 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1790 %! assert ([cast([1, 2], t1), cast([3, 4], t2)], cast ([1, 2, 3, 4], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1791 %!
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1792 %! if (nargin == 3 \|\| cmplx)
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1793 %! assert (cat (1, cast (1i, t1), cast (2, t2)), cast ([1i; 2], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1794 %! assert (cat (1, cast (1i, t1), cast ([2; 3], t2)), cast ([1i; 2; 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1795 %! assert (cat (1, cast ([1i; 2], t1), cast (3, t2)), cast ([1i; 2; 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1796 %! assert (cat (1, cast ([1i; 2], t1), cast ([3; 4], t2)), cast ([1i; 2; 3; 4], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1797 %! assert (cat (2, cast (1i, t1), cast (2, t2)), cast ([1i, 2], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1798 %! assert (cat (2, cast (1i, t1), cast ([2, 3], t2)), cast ([1i, 2, 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1799 %! assert (cat (2, cast ([1i, 2], t1), cast (3, t2)), cast ([1i, 2, 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1800 %! assert (cat (2, cast ([1i, 2], t1), cast ([3, 4], t2)), cast ([1i, 2, 3, 4], tr));
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1801 %!
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1802 %! assert ([cast(1i, t1); cast(2, t2)], cast ([1i; 2], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1803 %! assert ([cast(1i, t1); cast([2; 3], t2)], cast ([1i; 2; 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1804 %! assert ([cast([1i; 2], t1); cast(3, t2)], cast ([1i; 2; 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1805 %! assert ([cast([1i; 2], t1); cast([3; 4], t2)], cast ([1i; 2; 3; 4], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1806 %! assert ([cast(1i, t1), cast(2, t2)], cast ([1i, 2], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1807 %! assert ([cast(1i, t1), cast([2, 3], t2)], cast ([1i, 2, 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1808 %! assert ([cast([1i, 2], t1), cast(3, t2)], cast ([1i, 2, 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1809 %! assert ([cast([1i, 2], t1), cast([3, 4], t2)], cast ([1i, 2, 3, 4], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1810 %!
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1811 %! assert (cat (1, cast (1, t1), cast (2i, t2)), cast ([1; 2i], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1812 %! assert (cat (1, cast (1, t1), cast ([2i; 3], t2)), cast ([1; 2i; 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1813 %! assert (cat (1, cast ([1; 2], t1), cast (3i, t2)), cast ([1; 2; 3i], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1814 %! assert (cat (1, cast ([1; 2], t1), cast ([3i; 4], t2)), cast ([1; 2; 3i; 4], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1815 %! assert (cat (2, cast (1, t1), cast (2i, t2)), cast ([1, 2i], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1816 %! assert (cat (2, cast (1, t1), cast ([2i, 3], t2)), cast ([1, 2i, 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1817 %! assert (cat (2, cast ([1, 2], t1), cast (3i, t2)), cast ([1, 2, 3i], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1818 %! assert (cat (2, cast ([1, 2], t1), cast ([3i, 4], t2)), cast ([1, 2, 3i, 4], tr));
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1819 %!
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1820 %! assert ([cast(1, t1); cast(2i, t2)], cast ([1; 2i], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1821 %! assert ([cast(1, t1); cast([2i; 3], t2)], cast ([1; 2i; 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1822 %! assert ([cast([1; 2], t1); cast(3i, t2)], cast ([1; 2; 3i], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1823 %! assert ([cast([1; 2], t1); cast([3i; 4], t2)], cast ([1; 2; 3i; 4], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1824 %! assert ([cast(1, t1), cast(2i, t2)], cast ([1, 2i], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1825 %! assert ([cast(1, t1), cast([2i, 3], t2)], cast ([1, 2i, 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1826 %! assert ([cast([1, 2], t1), cast(3i, t2)], cast ([1, 2, 3i], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1827 %! assert ([cast([1, 2], t1), cast([3i, 4], t2)], cast ([1, 2, 3i, 4], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1828 %!
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1829 %! assert (cat (1, cast (1i, t1), cast (2i, t2)), cast ([1i; 2i], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1830 %! assert (cat (1, cast (1i, t1), cast ([2i; 3], t2)), cast ([1i; 2i; 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1831 %! assert (cat (1, cast ([1i; 2], t1), cast (3i, t2)), cast ([1i; 2; 3i], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1832 %! assert (cat (1, cast ([1i; 2], t1), cast ([3i; 4], t2)), cast ([1i; 2; 3i; 4], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1833 %! assert (cat (2, cast (1i, t1), cast (2i, t2)), cast ([1i, 2i], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1834 %! assert (cat (2, cast (1i, t1), cast ([2i, 3], t2)), cast ([1i, 2i, 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1835 %! assert (cat (2, cast ([1i, 2], t1), cast (3i, t2)), cast ([1i, 2, 3i], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1836 %! assert (cat (2, cast ([1i, 2], t1), cast ([3i, 4], t2)), cast ([1i, 2, 3i, 4], tr));
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1837 %!
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1838 %! assert ([cast(1i, t1); cast(2i, t2)], cast ([1i; 2i], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1839 %! assert ([cast(1i, t1); cast([2i; 3], t2)], cast ([1i; 2i; 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1840 %! assert ([cast([1i; 2], t1); cast(3i, t2)], cast ([1i; 2; 3i], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1841 %! assert ([cast([1i; 2], t1); cast([3i; 4], t2)], cast ([1i; 2; 3i; 4], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1842 %! assert ([cast(1i, t1), cast(2i, t2)], cast ([1i, 2i], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1843 %! assert ([cast(1i, t1), cast([2i, 3], t2)], cast ([1i, 2i, 3], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1844 %! assert ([cast([1i, 2], t1), cast(3i, t2)], cast ([1i, 2, 3i], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1845 %! assert ([cast([1i, 2], t1), cast([3i, 4], t2)], cast ([1i, 2, 3i, 4], tr));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1846 %! endif
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1847 %! ret = true;
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1848
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1849 %!assert (testcat('double', 'double', 'double'));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1850 %!assert (testcat('single', 'double', 'single'));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1851 %!assert (testcat('double', 'single', 'single'));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1852 %!assert (testcat('single', 'single', 'single'));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1853
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1854 %!assert (testcat('double', 'int8', 'int8', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1855 %!assert (testcat('int8', 'double', 'int8', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1856 %!assert (testcat('single', 'int8', 'int8', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1857 %!assert (testcat('int8', 'single', 'int8', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1858 %!assert (testcat('int8', 'int8', 'int8', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1859 %!assert (testcat('double', 'int16', 'int16', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1860 %!assert (testcat('int16', 'double', 'int16', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1861 %!assert (testcat('single', 'int16', 'int16', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1862 %!assert (testcat('int16', 'single', 'int16', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1863 %!assert (testcat('int16', 'int16', 'int16', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1864 %!assert (testcat('double', 'int32', 'int32', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1865 %!assert (testcat('int32', 'double', 'int32', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1866 %!assert (testcat('single', 'int32', 'int32', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1867 %!assert (testcat('int32', 'single', 'int32', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1868 %!assert (testcat('int32', 'int32', 'int32', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1869 %!assert (testcat('double', 'int64', 'int64', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1870 %!assert (testcat('int64', 'double', 'int64', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1871 %!assert (testcat('single', 'int64', 'int64', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1872 %!assert (testcat('int64', 'single', 'int64', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1873 %!assert (testcat('int64', 'int64', 'int64', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1874
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1875 %!assert (testcat('double', 'uint8', 'uint8', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1876 %!assert (testcat('uint8', 'double', 'uint8', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1877 %!assert (testcat('single', 'uint8', 'uint8', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1878 %!assert (testcat('uint8', 'single', 'uint8', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1879 %!assert (testcat('uint8', 'uint8', 'uint8', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1880 %!assert (testcat('double', 'uint16', 'uint16', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1881 %!assert (testcat('uint16', 'double', 'uint16', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1882 %!assert (testcat('single', 'uint16', 'uint16', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1883 %!assert (testcat('uint16', 'single', 'uint16', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1884 %!assert (testcat('uint16', 'uint16', 'uint16', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1885 %!assert (testcat('double', 'uint32', 'uint32', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1886 %!assert (testcat('uint32', 'double', 'uint32', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1887 %!assert (testcat('single', 'uint32', 'uint32', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1888 %!assert (testcat('uint32', 'single', 'uint32', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1889 %!assert (testcat('uint32', 'uint32', 'uint32', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1890 %!assert (testcat('double', 'uint64', 'uint64', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1891 %!assert (testcat('uint64', 'double', 'uint64', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1892 %!assert (testcat('single', 'uint64', 'uint64', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1893 %!assert (testcat('uint64', 'single', 'uint64', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1894 %!assert (testcat('uint64', 'uint64', 'uint64', false));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1895
11241 80e01d79cf80 special case for concatenation of empty matrices John W. Eaton <jwe@octave.org> parents: 11209 diff changeset	1896 %!assert (cat (3, [], [1,2;3,4]), [1,2;3,4]);
80e01d79cf80 special case for concatenation of empty matrices John W. Eaton <jwe@octave.org> parents: 11209 diff changeset	1897 %!assert (cat (3, [1,2;3,4], []), [1,2;3,4]);
80e01d79cf80 special case for concatenation of empty matrices John W. Eaton <jwe@octave.org> parents: 11209 diff changeset	1898 %!assert (cat (3, [], [1,2;3,4], []), [1,2;3,4]);
80e01d79cf80 special case for concatenation of empty matrices John W. Eaton <jwe@octave.org> parents: 11209 diff changeset	1899 %!assert (cat (3, [], [], []), zeros (0, 0, 3));
80e01d79cf80 special case for concatenation of empty matrices John W. Eaton <jwe@octave.org> parents: 11209 diff changeset	1900
11242 0090bb47d0b5 simplify special case for concatenation of empty matrices John W. Eaton <jwe@octave.org> parents: 11241 diff changeset	1901 %!assert (cat (3, [], [], 1, 2), cat (3, 1, 2));
11241 80e01d79cf80 special case for concatenation of empty matrices John W. Eaton <jwe@octave.org> parents: 11209 diff changeset	1902 %!assert (cat (3, [], [], [1,2;3,4]), [1,2;3,4]);
80e01d79cf80 special case for concatenation of empty matrices John W. Eaton <jwe@octave.org> parents: 11209 diff changeset	1903 %!assert (cat (4, [], [], [1,2;3,4]), [1,2;3,4]);
80e01d79cf80 special case for concatenation of empty matrices John W. Eaton <jwe@octave.org> parents: 11209 diff changeset	1904 %!error <dimension mismatch> cat (3, cat (3, [], []), [1,2;3,4]);
80e01d79cf80 special case for concatenation of empty matrices John W. Eaton <jwe@octave.org> parents: 11209 diff changeset	1905 %!error <dimension mismatch> cat (3, zeros (0, 0, 2), [1,2;3,4]);
10498 8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1906
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1907 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1908
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1909 static octave_value
6959 47f4f4e88166 [project @ 2007-10-04 20:43:32 by jwe] jwe parents: 6953 diff changeset	1910 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	1911 {
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1912 octave_value retval;
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1913
5148 9eab94f5fadf [project @ 2005-02-18 19:04:34 by jwe] jwe parents: 5061 diff changeset	1914 if (args.length () == 2 && args(1).length () >= args(1).ndims ())
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1915 {
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1916 Array<int> vec = args(1).int_vector_value ();
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1917
5775 ace8d8d26933 [project @ 2006-04-24 19:13:06 by jwe] jwe parents: 5747 diff changeset	1918 // FIXME -- maybe we should create an idx_vector object
5148 9eab94f5fadf [project @ 2005-02-18 19:04:34 by jwe] jwe parents: 5061 diff changeset	1919 // here and pass that to permute?
9eab94f5fadf [project @ 2005-02-18 19:04:34 by jwe] jwe parents: 5061 diff changeset	1920
9eab94f5fadf [project @ 2005-02-18 19:04:34 by jwe] jwe parents: 5061 diff changeset	1921 int n = vec.length ();
9eab94f5fadf [project @ 2005-02-18 19:04:34 by jwe] jwe parents: 5061 diff changeset	1922
9eab94f5fadf [project @ 2005-02-18 19:04:34 by jwe] jwe parents: 5061 diff changeset	1923 for (int i = 0; i < n; i++)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1924 vec(i)--;
5148 9eab94f5fadf [project @ 2005-02-18 19:04:34 by jwe] jwe parents: 5061 diff changeset	1925
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1926 octave_value ret = args(0).permute (vec, inv);
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1927
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1928 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1929 retval = ret;
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1930 }
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1931 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	1932 print_usage ();
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1933
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1934 return retval;
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1935 }
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1936
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1937 DEFUN (permute, args, ,
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1938 "-- texinfo --\n\
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1939 @deftypefn {Built-in Function} {} permute (@var{a}, @var{perm})\n\
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1940 Return the generalized transpose for an N-d array object @var{a}.\n\
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1941 The permutation vector @var{perm} must contain the elements\n\
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1942 @code{1:ndims(a)} (in any order, but each element must appear just once).\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5607 diff changeset	1943 @seealso{ipermute}\n\
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5607 diff changeset	1944 @end deftypefn")
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1945 {
6959 47f4f4e88166 [project @ 2007-10-04 20:43:32 by jwe] jwe parents: 6953 diff changeset	1946 return do_permute (args, false);
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1947 }
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1948
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1949 DEFUN (ipermute, args, ,
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1950 "-- texinfo --\n\
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1951 @deftypefn {Built-in Function} {} ipermute (@var{a}, @var{iperm})\n\
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1952 The inverse of the @code{permute} function. The expression\n\
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1953 \n\
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1954 @example\n\
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1955 ipermute (permute (a, perm), perm)\n\
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1956 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	1957 \n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	1958 @noindent\n\
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1959 returns the original array @var{a}.\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5607 diff changeset	1960 @seealso{permute}\n\
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5607 diff changeset	1961 @end deftypefn")
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1962 {
6959 47f4f4e88166 [project @ 2007-10-04 20:43:32 by jwe] jwe parents: 6953 diff changeset	1963 return do_permute (args, true);
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1964 }
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	1965
3195 7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	1966 DEFUN (length, args, ,
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	1967 "-- texinfo --\n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	1968 @deftypefn {Built-in Function} {} length (@var{a})\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	1969 Return the \"length\" of the object @var{a}. For matrix objects, the\n\
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	1970 length is the number of rows or columns, whichever is greater (this\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	1971 odd definition is used for compatibility with @sc{matlab}).\n\
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	1972 @end deftypefn")
3195 7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	1973 {
7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	1974 octave_value retval;
7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	1975
7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	1976 if (args.length () == 1)
9706 71160b139b07 simplify length,ndims,size and size_equal Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	1977 retval = args(0).length ();
3195 7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	1978 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	1979 print_usage ();
3195 7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	1980
7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	1981 return retval;
7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	1982 }
7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	1983
4554 78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	1984 DEFUN (ndims, args, ,
78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	1985 "-- texinfo --\n\
78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	1986 @deftypefn {Built-in Function} {} ndims (@var{a})\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	1987 Return the number of dimensions of @var{a}.\n\
4554 78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	1988 For any array, the result will always be larger than or equal to 2.\n\
78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	1989 Trailing singleton dimensions are not counted.\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	1990 \n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	1991 @example\n\
10711 fbd7843974fa Periodic grammar check of documentation files to ensure common format. Rik <octave@nomad.inbox5.com> parents: 10707 diff changeset	1992 @group\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	1993 ndims (ones (4, 1, 2, 1)\n\
a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	1994 @result{} 3\n\
10711 fbd7843974fa Periodic grammar check of documentation files to ensure common format. Rik <octave@nomad.inbox5.com> parents: 10707 diff changeset	1995 @end group\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	1996 @end example\n\
4554 78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	1997 @end deftypefn")
78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	1998 {
78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	1999 octave_value retval;
78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2000
78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2001 if (args.length () == 1)
9706 71160b139b07 simplify length,ndims,size and size_equal Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	2002 retval = args(0).ndims ();
4554 78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2003 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2004 print_usage ();
4554 78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2005
78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2006 return retval;
78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2007 }
78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2008
4559 802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2009 DEFUN (numel, args, ,
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2010 "-- texinfo --\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	2011 @deftypefn {Built-in Function} {} numel (@var{a})\n\
9705 5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2012 @deftypefnx {Built-in Function} {} numel (@var{a}, @var{idx1}, @var{idx2}, @dots{})\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	2013 Return the number of elements in the object @var{a}.\n\
9705 5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2014 Optionally, if indices @var{idx1}, @var{idx2}, @dots{} are supplied,\n\
5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2015 return the number of elements that would result from the indexing\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	2016 \n\
9705 5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2017 @example\n\
5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2018 @var{a}(@var{idx1}, @var{idx2}, @dots{})\n\
5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2019 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	2020 \n\
9705 5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2021 This method is also called when an object appears as lvalue with cs-list\n\
9758 09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format Rik <rdrider0-list@yahoo.com> parents: 9736 diff changeset	2022 indexing, i.e., @code{object@{@dots{}@}} or @code{object(@dots{}).field}.\n\
5724 82247c2a7520 [project @ 2006-03-30 21:34:52 by jwe] jwe parents: 5714 diff changeset	2023 @seealso{size}\n\
4559 802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2024 @end deftypefn")
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2025 {
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2026 octave_value retval;
9329 67fc970dad7d improve indexed assignment using indexed numel Jaroslav Hajek <highegg@gmail.com> parents: 9319 diff changeset	2027 octave_idx_type nargin = args.length ();
67fc970dad7d improve indexed assignment using indexed numel Jaroslav Hajek <highegg@gmail.com> parents: 9319 diff changeset	2028
9705 5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2029 if (nargin == 1)
5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2030 retval = args(0).numel ();
5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2031 else if (nargin > 1)
4559 802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2032 {
9705 5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2033 // 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	2034 // an overloaded call, not to builtin!
5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2035 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	2036 }
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2037 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2038 print_usage ();
4559 802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2039
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2040 return retval;
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2041 }
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2042
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	2043 DEFUN (size, args, nargout,
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2044 "-- texinfo --\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	2045 @deftypefn {Built-in Function} {} size (@var{a})\n\
a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	2046 @deftypefnx {Built-in Function} {} size (@var{a}, @var{dim})\n\
12546 39ca02387a32 Improve docstrings for a number of functions. Rik <octave@nomad.inbox5.com> parents: 12483 diff changeset	2047 Return the number of rows and columns of @var{a}.\n\
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2048 \n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2049 With one input argument and one output argument, the result is returned\n\
4741 e44d0ac643a5 [project @ 2004-02-05 21:57:50 by jwe] jwe parents: 4739 diff changeset	2050 in a row vector. If there are multiple output arguments, the number of\n\
e44d0ac643a5 [project @ 2004-02-05 21:57:50 by jwe] jwe parents: 4739 diff changeset	2051 rows is assigned to the first, and the number of columns to the second,\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	2052 etc. For example:\n\
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2053 \n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2054 @example\n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2055 @group\n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2056 size ([1, 2; 3, 4; 5, 6])\n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2057 @result{} [ 3, 2 ]\n\
1031 59f5eb2d5eb3 [project @ 1995-01-15 21:11:11 by jwe] jwe parents: 1009 diff changeset	2058 \n\
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2059 [nr, nc] = size ([1, 2; 3, 4; 5, 6])\n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2060 @result{} nr = 3\n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2061 @result{} nc = 2\n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2062 @end group\n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2063 @end example\n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2064 \n\
4741 e44d0ac643a5 [project @ 2004-02-05 21:57:50 by jwe] jwe parents: 4739 diff changeset	2065 If given a second argument, @code{size} will return the size of the\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	2066 corresponding dimension. For example,\n\
1031 59f5eb2d5eb3 [project @ 1995-01-15 21:11:11 by jwe] jwe parents: 1009 diff changeset	2067 \n\
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2068 @example\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	2069 @group\n\
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2070 size ([1, 2; 3, 4; 5, 6], 2)\n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2071 @result{} 2\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	2072 @end group\n\
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2073 @end example\n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2074 \n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2075 @noindent\n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2076 returns the number of columns in the given matrix.\n\
5724 82247c2a7520 [project @ 2006-03-30 21:34:52 by jwe] jwe parents: 5714 diff changeset	2077 @seealso{numel}\n\
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2078 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2079 {
2086 bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe] jwe parents: 1996 diff changeset	2080 octave_value_list retval;
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2081
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2082 int nargin = args.length ();
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2083
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4512 diff changeset	2084 if (nargin == 1)
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2085 {
9706 71160b139b07 simplify length,ndims,size and size_equal Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	2086 const dim_vector dimensions = args(0).dims ();
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4512 diff changeset	2087
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4512 diff changeset	2088 if (nargout > 1)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2089 {
9706 71160b139b07 simplify length,ndims,size and size_equal Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	2090 const dim_vector rdims = dimensions.redim (nargout);
71160b139b07 simplify length,ndims,size and size_equal Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	2091 retval.resize (nargout);
71160b139b07 simplify length,ndims,size and size_equal Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	2092 for (int i = 0; i < nargout; i++)
71160b139b07 simplify length,ndims,size and size_equal Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	2093 retval(i) = rdims(i);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2094 }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4512 diff changeset	2095 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2096 {
9706 71160b139b07 simplify length,ndims,size and size_equal Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	2097 int ndims = dimensions.length ();
71160b139b07 simplify length,ndims,size and size_equal Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	2098
71160b139b07 simplify length,ndims,size and size_equal Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	2099 NoAlias<Matrix> m (1, ndims);
71160b139b07 simplify length,ndims,size and size_equal Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	2100
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2101 for (int i = 0; i < ndims; i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2102 m(i) = dimensions(i);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2103
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2104 retval(0) = m;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2105 }
1031 59f5eb2d5eb3 [project @ 1995-01-15 21:11:11 by jwe] jwe parents: 1009 diff changeset	2106 }
59f5eb2d5eb3 [project @ 1995-01-15 21:11:11 by jwe] jwe parents: 1009 diff changeset	2107 else if (nargin == 2 && nargout < 2)
59f5eb2d5eb3 [project @ 1995-01-15 21:11:11 by jwe] jwe parents: 1009 diff changeset	2108 {
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5164 diff changeset	2109 octave_idx_type nd = args(1).int_value (true);
1031 59f5eb2d5eb3 [project @ 1995-01-15 21:11:11 by jwe] jwe parents: 1009 diff changeset	2110
59f5eb2d5eb3 [project @ 1995-01-15 21:11:11 by jwe] jwe parents: 1009 diff changeset	2111 if (error_state)
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	2112 error ("size: DIM must be a scalar");
712 36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	2113 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2114 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2115 const dim_vector dv = args(0).dims ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2116
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2117 if (nd > 0)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2118 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2119 if (nd <= dv.length ())
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2120 retval(0) = dv(nd-1);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	2121 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2122 retval(0) = 1;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2123 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2124 else
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	2125 error ("size: requested dimension DIM (= %d) out of range", nd);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2126 }
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2127 }
712 36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	2128 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2129 print_usage ();
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2130
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2131 return retval;
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2132 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2133
6156 a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2134 DEFUN (size_equal, args, ,
a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2135 "-- texinfo --\n\
6561 dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2136 @deftypefn {Built-in Function} {} size_equal (@var{a}, @var{b}, @dots{})\n\
dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2137 Return true if the dimensions of all arguments agree.\n\
6156 a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2138 Trailing singleton dimensions are ignored.\n\
10002 e93c9bfff8b8 allow size_equal with 0 arguments Jaroslav Hajek <highegg@gmail.com> parents: 9866 diff changeset	2139 Called with a single or no argument, size_equal returns true.\n\
6156 a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2140 @seealso{size, numel}\n\
a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2141 @end deftypefn")
a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2142 {
a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2143 octave_value retval;
a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2144
6561 dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2145 int nargin = args.length ();
dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2146
10002 e93c9bfff8b8 allow size_equal with 0 arguments Jaroslav Hajek <highegg@gmail.com> parents: 9866 diff changeset	2147 retval = true;
e93c9bfff8b8 allow size_equal with 0 arguments Jaroslav Hajek <highegg@gmail.com> parents: 9866 diff changeset	2148
8947 1e4b3149365a allow size_equal called with 1 arg Jaroslav Hajek <highegg@gmail.com> parents: 8934 diff changeset	2149 if (nargin >= 1)
6156 a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2150 {
a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2151 dim_vector a_dims = args(0).dims ();
6561 dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2152
dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2153 for (int i = 1; i < nargin; ++i)
dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2154 {
dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2155 dim_vector b_dims = args(i).dims ();
dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2156
dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2157 if (a_dims != b_dims)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2158 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2159 retval = false;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2160 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2161 }
6561 dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2162 }
6156 a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2163 }
a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2164
a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2165 return retval;
a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2166 }
a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2167
5602 dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2168 DEFUN (nnz, args, ,
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2169 "-- texinfo --\n\
6156 a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2170 @deftypefn {Built-in Function} {@var{scalar} =} nnz (@var{a})\n\
11572 7d6d8c1e471f Grammarcheck Texinfo for files in src directory. Rik <octave@nomad.inbox5.com> parents: 11570 diff changeset	2171 Return the number of non zero elements in @var{a}.\n\
5602 dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2172 @seealso{sparse}\n\
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2173 @end deftypefn")
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2174 {
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2175 octave_value retval;
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2176
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2177 if (args.length () == 1)
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2178 retval = args(0).nnz ();
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2179 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2180 print_usage ();
5602 dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2181
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2182 return retval;
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2183 }
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2184
5604 2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2185 DEFUN (nzmax, args, ,
2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2186 "-- texinfo --\n\
6156 a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2187 @deftypefn {Built-in Function} {@var{scalar} =} nzmax (@var{SM})\n\
5604 2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2188 Return the amount of storage allocated to the sparse matrix @var{SM}.\n\
7001 8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe] jwe parents: 6999 diff changeset	2189 Note that Octave tends to crop unused memory at the first opportunity\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	2190 for sparse objects. There are some cases of user created sparse objects\n\
9066 be150a172010 Cleanup documentation for diagperm.texi, sparse.texi Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	2191 where the value returned by @dfn{nzmax} will not be the same as @dfn{nnz},\n\
5604 2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2192 but in general they will give the same result.\n\
2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2193 @seealso{sparse, spalloc}\n\
2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2194 @end deftypefn")
2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2195 {
2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2196 octave_value retval;
2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2197
2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2198 if (args.length() == 1)
2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2199 retval = args(0).nzmax ();
2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2200 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2201 print_usage ();
5604 2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2202
2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2203 return retval;
2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2204 }
2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2205
5677 a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2206 DEFUN (rows, args, ,
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2207 "-- texinfo --\n\
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2208 @deftypefn {Built-in Function} {} rows (@var{a})\n\
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2209 Return the number of rows of @var{a}.\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	2210 @seealso{columns, size, length, numel, isscalar, isvector, ismatrix}\n\
5677 a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2211 @end deftypefn")
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2212 {
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2213 octave_value retval;
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2214
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2215 if (args.length () == 1)
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2216 retval = args(0).rows ();
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2217 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2218 print_usage ();
5677 a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2219
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2220 return retval;
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2221 }
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2222
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2223 DEFUN (columns, args, ,
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2224 "-- texinfo --\n\
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2225 @deftypefn {Built-in Function} {} columns (@var{a})\n\
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2226 Return the number of columns of @var{a}.\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	2227 @seealso{rows, size, length, numel, isscalar, isvector, ismatrix}\n\
5677 a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2228 @end deftypefn")
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2229 {
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2230 octave_value retval;
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2231
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2232 if (args.length () == 1)
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2233 retval = args(0).columns ();
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2234 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2235 print_usage ();
5677 a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2236
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2237 return retval;
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2238 }
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2239
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	2240 DEFUN (sum, args, ,
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	2241 "-- texinfo --\n\
9163 9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	2242 @deftypefn {Built-in Function} {} sum (@var{x})\n\
9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	2243 @deftypefnx {Built-in Function} {} sum (@var{x}, @var{dim})\n\
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	2244 @deftypefnx {Built-in Function} {} sum (@dots{}, 'native')\n\
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2245 @deftypefnx {Built-in Function} {} sum (@dots{}, 'double')\n\
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2246 @deftypefnx {Built-in Function} {} sum (@dots{}, 'extra')\n\
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	2247 Sum of elements along dimension @var{dim}. If @var{dim} is\n\
9723 f426899f4b9c fix reduction functions docstrings Jaroslav Hajek <highegg@gmail.com> parents: 9721 diff changeset	2248 omitted, it defaults to the first non-singleton dimension.\n\
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	2249 \n\
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	2250 If the optional argument 'native' is given, then the sum is performed\n\
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	2251 in the same type as the original argument, rather than in the default\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	2252 double type. For example:\n\
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	2253 \n\
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	2254 @example\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	2255 @group\n\
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	2256 sum ([true, true])\n\
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	2257 @result{} 2\n\
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	2258 sum ([true, true], 'native')\n\
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	2259 @result{} true\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	2260 @end group\n\
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	2261 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	2262 \n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	2263 On the contrary, if 'double' is given, the sum is performed in double\n\
a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	2264 precision even for single precision inputs.\n\
9723 f426899f4b9c fix reduction functions docstrings Jaroslav Hajek <highegg@gmail.com> parents: 9721 diff changeset	2265 \n\
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2266 For double precision inputs, 'extra' indicates that a more accurate algorithm\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	2267 than straightforward summation is to be used. For single precision inputs,\n\
89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	2268 'extra' is the same as 'double'. Otherwise, 'extra' has no effect.\n\
9163 9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	2269 @seealso{cumsum, sumsq, prod}\n\
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	2270 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2271 {
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2272 octave_value retval;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2273
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2274 int nargin = args.length ();
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2275
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2276 bool isnative = false;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2277 bool isdouble = false;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2278 bool isextra = false;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2279
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2280 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	2281 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2282 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	2283
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2284 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2285 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2286 if (str == "native")
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2287 isnative = true;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2288 else if (str == "double")
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2289 isdouble = true;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2290 else if (str == "extra")
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2291 isextra = true;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2292 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2293 error ("sum: unrecognized string argument");
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2294 nargin --;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2295 }
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2296 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2297
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2298 if (error_state)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2299 return retval;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2300
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2301 if (nargin == 1 \|\| nargin == 2)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2302 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2303 octave_value arg = args(0);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2304
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2305 int dim = -1;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2306 if (nargin == 2)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2307 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2308 dim = args(1).int_value () - 1;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2309 if (dim < 0)
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	2310 error ("sum: invalid dimension DIM = %d", dim + 1);
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2311 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2312
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2313 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2314 {
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2315 switch (arg.builtin_type ())
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2316 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2317 case btyp_double:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2318 if (arg.is_sparse_type ())
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2319 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2320 if (isextra)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2321 warning ("sum: 'extra' not yet implemented for sparse matrices");
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2322 retval = arg.sparse_matrix_value ().sum (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2323 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2324 else if (isextra)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2325 retval = arg.array_value ().xsum (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2326 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2327 retval = arg.array_value ().sum (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2328 break;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2329 case btyp_complex:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2330 if (arg.is_sparse_type ())
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2331 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2332 if (isextra)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2333 warning ("sum: 'extra' not yet implemented for sparse matrices");
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2334 retval = arg.sparse_complex_matrix_value ().sum (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2335 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2336 else if (isextra)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2337 retval = arg.complex_array_value ().xsum (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2338 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2339 retval = arg.complex_array_value ().sum (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2340 break;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2341 case btyp_float:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2342 if (isdouble \|\| isextra)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2343 retval = arg.float_array_value ().dsum (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2344 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2345 retval = arg.float_array_value ().sum (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2346 break;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2347 case btyp_float_complex:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2348 if (isdouble \|\| isextra)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2349 retval = arg.float_complex_array_value ().dsum (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2350 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2351 retval = arg.float_complex_array_value ().sum (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2352 break;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2353
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2354 #define MAKE_INT_BRANCH(X) \
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2355 case btyp_ ## X: \
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2356 if (isnative) \
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2357 retval = arg.X ## _array_value ().sum (dim); \
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2358 else \
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2359 retval = arg.X ## _array_value ().dsum (dim); \
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2360 break
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2361 MAKE_INT_BRANCH (int8);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2362 MAKE_INT_BRANCH (int16);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2363 MAKE_INT_BRANCH (int32);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2364 MAKE_INT_BRANCH (int64);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2365 MAKE_INT_BRANCH (uint8);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2366 MAKE_INT_BRANCH (uint16);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2367 MAKE_INT_BRANCH (uint32);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2368 MAKE_INT_BRANCH (uint64);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2369 #undef MAKE_INT_BRANCH
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2370
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2371 case btyp_bool:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2372 if (arg.is_sparse_type ())
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2373 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2374 if (isnative)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2375 retval = arg.sparse_bool_matrix_value ().any (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2376 else
10983 4b51c0a20a98 optimize sum of sparse logical matrices Jaroslav Hajek <highegg@gmail.com> parents: 10880 diff changeset	2377 retval = arg.sparse_bool_matrix_value ().sum (dim);
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2378 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2379 else if (isnative)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2380 retval = arg.bool_array_value ().any (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2381 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2382 retval = arg.bool_array_value ().sum (dim);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2383 break;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2384
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2385 default:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2386 gripe_wrong_type_arg ("sum", arg);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2387 }
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2388 }
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2389 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2390 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2391 print_usage ();
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2392
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	2393 return retval;
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2394 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2395
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	2396 /*
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	2397
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	2398 %!assert (sum([true,true]), 2)
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	2399 %!assert (sum([true,true],'native'), true)
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	2400 %!assert (sum(int8([127,10,-20])), 117);
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	2401 %!assert (sum(int8([127,10,-20]),'native'), int8(107));
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	2402
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2403 %!assert(sum ([1, 2, 3]), 6)
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2404 %!assert(sum ([-1; -2; -3]), -6);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2405 %!assert(sum ([i, 2+i, -3+2i, 4]), 3+4i);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2406 %!assert(sum ([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i]), [2+2i, 4+4i, 6+6i]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2407
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2408 %!assert(sum (single([1, 2, 3])), single(6))
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2409 %!assert(sum (single([-1; -2; -3])), single(-6));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2410 %!assert(sum (single([i, 2+i, -3+2i, 4])), single(3+4i));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2411 %!assert(sum (single([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i])), single([2+2i, 4+4i, 6+6i]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2412
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2413 %!error <Invalid call to sum.*> sum ();
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2414
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2415 %!assert (sum ([1, 2; 3, 4], 1), [4, 6]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2416 %!assert (sum ([1, 2; 3, 4], 2), [3; 7]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2417 %!assert (sum (zeros (1, 0)), 0);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2418 %!assert (sum (zeros (1, 0), 1), zeros(1, 0));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2419 %!assert (sum (zeros (1, 0), 2), 0);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2420 %!assert (sum (zeros (0, 1)), 0);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2421 %!assert (sum (zeros (0, 1), 1), 0);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2422 %!assert (sum (zeros (0, 1), 2), zeros(0, 1));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2423 %!assert (sum (zeros (2, 0)), zeros(1, 0));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2424 %!assert (sum (zeros (2, 0), 1), zeros(1, 0));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2425 %!assert (sum (zeros (2, 0), 2), [0; 0]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2426 %!assert (sum (zeros (0, 2)), [0, 0]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2427 %!assert (sum (zeros (0, 2), 1), [0, 0]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2428 %!assert (sum (zeros (0, 2), 2), zeros(0, 1));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2429 %!assert (sum (zeros (2, 2, 0, 3)), zeros(1, 2, 0, 3));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2430 %!assert (sum (zeros (2, 2, 0, 3), 2), zeros(2, 1, 0, 3));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2431 %!assert (sum (zeros (2, 2, 0, 3), 3), zeros(2, 2, 1, 3));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2432 %!assert (sum (zeros (2, 2, 0, 3), 4), zeros(2, 2, 0));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2433 %!assert (sum (zeros (2, 2, 0, 3), 7), zeros(2, 2, 0, 3));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2434
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2435 %!assert (sum (single([1, 2; 3, 4]), 1), single([4, 6]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2436 %!assert (sum (single([1, 2; 3, 4]), 2), single([3; 7]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2437 %!assert (sum (zeros (1, 0, 'single')), single(0));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2438 %!assert (sum (zeros (1, 0, 'single'), 1), zeros(1, 0, 'single'));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2439 %!assert (sum (zeros (1, 0, 'single'), 2), single(0));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2440 %!assert (sum (zeros (0, 1, 'single')), single(0));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2441 %!assert (sum (zeros (0, 1, 'single'), 1), single(0));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2442 %!assert (sum (zeros (0, 1, 'single'), 2), zeros(0, 1, 'single'));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2443 %!assert (sum (zeros (2, 0, 'single')), zeros(1, 0, 'single'));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2444 %!assert (sum (zeros (2, 0, 'single'), 1), zeros(1, 0, 'single'));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2445 %!assert (sum (zeros (2, 0, 'single'), 2), single([0; 0]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2446 %!assert (sum (zeros (0, 2, 'single')), single([0, 0]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2447 %!assert (sum (zeros (0, 2, 'single'), 1), single([0, 0]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2448 %!assert (sum (zeros (0, 2, 'single'), 2), zeros(0, 1, 'single'));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2449 %!assert (sum (zeros (2, 2, 0, 3, 'single')), zeros(1, 2, 0, 3, 'single'));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2450 %!assert (sum (zeros (2, 2, 0, 3, 'single'), 2), zeros(2, 1, 0, 3, 'single'));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2451 %!assert (sum (zeros (2, 2, 0, 3, 'single'), 3), zeros(2, 2, 1, 3, 'single'));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2452 %!assert (sum (zeros (2, 2, 0, 3, 'single'), 4), zeros(2, 2, 0, 'single'));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2453 %!assert (sum (zeros (2, 2, 0, 3, 'single'), 7), zeros(2, 2, 0, 3, 'single'));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2454
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	2455 */
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	2456
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	2457 DEFUN (sumsq, args, ,
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	2458 "-- texinfo --\n\
9163 9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	2459 @deftypefn {Built-in Function} {} sumsq (@var{x})\n\
9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	2460 @deftypefnx {Built-in Function} {} sumsq (@var{x}, @var{dim})\n\
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	2461 Sum of squares of elements along dimension @var{dim}. If @var{dim}\n\
9723 f426899f4b9c fix reduction functions docstrings Jaroslav Hajek <highegg@gmail.com> parents: 9721 diff changeset	2462 is omitted, it defaults to the first non-singleton dimension.\n\
5061 4689ee5e88ec [project @ 2004-11-03 21:23:42 by jwe] jwe parents: 5058 diff changeset	2463 \n\
4689ee5e88ec [project @ 2004-11-03 21:23:42 by jwe] jwe parents: 5058 diff changeset	2464 This function is conceptually equivalent to computing\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	2465 \n\
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	2466 @example\n\
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	2467 sum (x .* conj (x), dim)\n\
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	2468 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	2469 \n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	2470 @noindent\n\
9163 9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	2471 but it uses less memory and avoids calling @code{conj} if @var{x} is real.\n\
9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	2472 @seealso{sum}\n\
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	2473 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2474 {
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	2475 DATA_REDUCTION (sumsq);
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2476 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2477
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2478 /*
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2479
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2480 %!assert(sumsq ([1, 2, 3]), 14)
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2481 %!assert(sumsq ([-1; -2; 4i]), 21);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2482 %!assert(sumsq ([1, 2, 3; 2, 3, 4; 4i, 6i, 2]), [21, 49, 29]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2483
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2484 %!assert(sumsq (single([1, 2, 3])), single(14))
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2485 %!assert(sumsq (single([-1; -2; 4i])), single(21));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2486 %!assert(sumsq (single([1, 2, 3; 2, 3, 4; 4i, 6i, 2])), single([21, 49, 29]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2487
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2488 %!error <Invalid call to sumsq.*> sumsq ();
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2489
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2490 %!assert (sumsq ([1, 2; 3, 4], 1), [10, 20]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2491 %!assert (sumsq ([1, 2; 3, 4], 2), [5; 25]);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2492
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2493 %!assert (sumsq (single([1, 2; 3, 4]), 1), single([10, 20]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2494 %!assert (sumsq (single([1, 2; 3, 4]), 2), single([5; 25]));
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2495
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2496 */
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2497
6688 b26a8e0e42cd [project @ 2007-06-04 06:25:21 by jwe] jwe parents: 6671 diff changeset	2498 DEFUN (islogical, args, ,
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	2499 "-- texinfo --\n\
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	2500 @deftypefn {Built-in Function} {} islogical (@var{x})\n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	2501 @deftypefnx {Built-in Function} {} isbool (@var{x})\n\
6688 b26a8e0e42cd [project @ 2007-06-04 06:25:21 by jwe] jwe parents: 6671 diff changeset	2502 Return true if @var{x} is a logical object.\n\
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	2503 @seealso{isfloat, isinteger, ischar, isnumeric, isa}\n\
3439 3234a698073a [project @ 2000-01-14 09:51:14 by jwe] jwe parents: 3428 diff changeset	2504 @end deftypefn")
3209 fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	2505 {
fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	2506 octave_value retval;
fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	2507
fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	2508 if (args.length () == 1)
3258 4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	2509 retval = args(0).is_bool_type ();
3209 fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	2510 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2511 print_usage ();
3209 fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	2512
fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	2513 return retval;
fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	2514 }
fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	2515
6688 b26a8e0e42cd [project @ 2007-06-04 06:25:21 by jwe] jwe parents: 6671 diff changeset	2516 DEFALIAS (isbool, islogical);
3209 fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	2517
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2518 /*
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2519
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2520 %!assert (islogical(true), true)
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2521 %!assert (islogical(false), true)
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2522 %!assert (islogical([true, false]), true)
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2523 %!assert (islogical(1), false)
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2524 %!assert (islogical(1i), false)
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2525 %!assert (islogical([1,1]), false)
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2526 %!assert (islogical(single(1)), false)
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2527 %!assert (islogical(single(1i)), false)
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2528 %!assert (islogical(single([1,1])), false)
11435 20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	2529 %!assert (islogical(sparse ([true, false])), true)
20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	2530 %!assert (islogical(sparse ([1, 0])), false)
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2531
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2532 */
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2533
6223 a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	2534 DEFUN (isinteger, args, ,
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	2535 "-- texinfo --\n\
6230 06bee64edc08 [project @ 2007-01-08 16:59:35 by jwe] jwe parents: 6223 diff changeset	2536 @deftypefn {Built-in Function} {} isinteger (@var{x})\n\
6223 a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	2537 Return true if @var{x} is an integer object (int8, uint8, int16, etc.).\n\
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	2538 Note that @w{@code{isinteger (14)}} is false because numeric constants in\n\
8429 f34ab2b433e8 One word missing from int8 help string. Francesco PotortÃ¬ <pot@gnu.org> parents: 8366 diff changeset	2539 Octave are double precision floating point values.\n\
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	2540 @seealso{isfloat, ischar, islogical, isnumeric, isa}\n\
6223 a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	2541 @end deftypefn")
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	2542 {
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	2543 octave_value retval;
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	2544
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	2545 if (args.length () == 1)
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	2546 retval = args(0).is_integer_type ();
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	2547 else
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	2548 print_usage ();
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	2549
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	2550 return retval;
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	2551 }
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	2552
4028 ef75c970c8f5 [project @ 2002-08-09 07:19:02 by jwe] jwe parents: 4025 diff changeset	2553 DEFUN (iscomplex, args, ,
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	2554 "-- texinfo --\n\
4028 ef75c970c8f5 [project @ 2002-08-09 07:19:02 by jwe] jwe parents: 4025 diff changeset	2555 @deftypefn {Built-in Function} {} iscomplex (@var{x})\n\
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	2556 Return true if @var{x} is a complex-valued numeric object.\n\
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	2557 @seealso{isreal, isnumeric}\n\
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	2558 @end deftypefn")
3186 edaa9a2d3d9c [project @ 1998-10-02 19:12:19 by jwe] jwe parents: 3174 diff changeset	2559 {
edaa9a2d3d9c [project @ 1998-10-02 19:12:19 by jwe] jwe parents: 3174 diff changeset	2560 octave_value retval;
edaa9a2d3d9c [project @ 1998-10-02 19:12:19 by jwe] jwe parents: 3174 diff changeset	2561
edaa9a2d3d9c [project @ 1998-10-02 19:12:19 by jwe] jwe parents: 3174 diff changeset	2562 if (args.length () == 1)
3258 4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	2563 retval = args(0).is_complex_type ();
3186 edaa9a2d3d9c [project @ 1998-10-02 19:12:19 by jwe] jwe parents: 3174 diff changeset	2564 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2565 print_usage ();
3186 edaa9a2d3d9c [project @ 1998-10-02 19:12:19 by jwe] jwe parents: 3174 diff changeset	2566
edaa9a2d3d9c [project @ 1998-10-02 19:12:19 by jwe] jwe parents: 3174 diff changeset	2567 return retval;
edaa9a2d3d9c [project @ 1998-10-02 19:12:19 by jwe] jwe parents: 3174 diff changeset	2568 }
edaa9a2d3d9c [project @ 1998-10-02 19:12:19 by jwe] jwe parents: 3174 diff changeset	2569
7576 7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	2570 DEFUN (isfloat, args, ,
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	2571 "-- texinfo --\n\
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	2572 @deftypefn {Built-in Function} {} isfloat (@var{x})\n\
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	2573 Return true if @var{x} is a floating-point numeric object.\n\
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	2574 Objects of class double or single are floating-point objects.\n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	2575 @seealso{isinteger, ischar, islogical, isnumeric, isa}\n\
7576 7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	2576 @end deftypefn")
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	2577 {
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	2578 octave_value retval;
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	2579
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	2580 if (args.length () == 1)
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	2581 retval = args(0).is_float_type ();
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	2582 else
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	2583 print_usage ();
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	2584
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	2585 return retval;
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	2586 }
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	2587
5775 ace8d8d26933 [project @ 2006-04-24 19:13:06 by jwe] jwe parents: 5747 diff changeset	2588 // FIXME -- perhaps this should be implemented with an
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2589 // octave_value member function?
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2590
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2591 DEFUN (complex, args, ,
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2592 "-- texinfo --\n\
9309 fb8b8589dd46 Expand documentation for 'complex' function Rik <rdrider0-list@yahoo.com> parents: 9308 diff changeset	2593 @deftypefn {Built-in Function} {} complex (@var{x})\n\
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2594 @deftypefnx {Built-in Function} {} complex (@var{re}, @var{im})\n\
9309 fb8b8589dd46 Expand documentation for 'complex' function Rik <rdrider0-list@yahoo.com> parents: 9308 diff changeset	2595 Return a complex result from real arguments. With 1 real argument @var{x},\n\
fb8b8589dd46 Expand documentation for 'complex' function Rik <rdrider0-list@yahoo.com> parents: 9308 diff changeset	2596 return the complex result @code{@var{x} + 0i}. With 2 real arguments,\n\
fb8b8589dd46 Expand documentation for 'complex' function Rik <rdrider0-list@yahoo.com> parents: 9308 diff changeset	2597 return the complex result @code{@var{re} + @var{im}}. @code{complex} can\n\
fb8b8589dd46 Expand documentation for 'complex' function Rik <rdrider0-list@yahoo.com> parents: 9308 diff changeset	2598 often be more convenient than expressions such as @code{a + i*b}.\n\
fb8b8589dd46 Expand documentation for 'complex' function Rik <rdrider0-list@yahoo.com> parents: 9308 diff changeset	2599 For example:\n\
fb8b8589dd46 Expand documentation for 'complex' function Rik <rdrider0-list@yahoo.com> parents: 9308 diff changeset	2600 \n\
fb8b8589dd46 Expand documentation for 'complex' function Rik <rdrider0-list@yahoo.com> parents: 9308 diff changeset	2601 @example\n\
9758 09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format Rik <rdrider0-list@yahoo.com> parents: 9736 diff changeset	2602 @group\n\
9309 fb8b8589dd46 Expand documentation for 'complex' function Rik <rdrider0-list@yahoo.com> parents: 9308 diff changeset	2603 complex ([1, 2], [3, 4])\n\
fb8b8589dd46 Expand documentation for 'complex' function Rik <rdrider0-list@yahoo.com> parents: 9308 diff changeset	2604 @result{}\n\
fb8b8589dd46 Expand documentation for 'complex' function Rik <rdrider0-list@yahoo.com> parents: 9308 diff changeset	2605 1 + 3i 2 + 4i\n\
9758 09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format Rik <rdrider0-list@yahoo.com> parents: 9736 diff changeset	2606 @end group\n\
9309 fb8b8589dd46 Expand documentation for 'complex' function Rik <rdrider0-list@yahoo.com> parents: 9308 diff changeset	2607 @end example\n\
fb8b8589dd46 Expand documentation for 'complex' function Rik <rdrider0-list@yahoo.com> parents: 9308 diff changeset	2608 @seealso{real, imag, iscomplex}\n\
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2609 @end deftypefn")
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2610 {
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2611 octave_value retval;
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2612
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2613 int nargin = args.length ();
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2614
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2615 if (nargin == 1)
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2616 {
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2617 octave_value arg = args(0);
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2618
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2619 if (arg.is_complex_type ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2620 retval = arg;
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2621 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2622 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2623 if (arg.is_sparse_type ())
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2624 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2625 SparseComplexMatrix val = arg.sparse_complex_matrix_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2626
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2627 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2628 retval = octave_value (new octave_sparse_complex_matrix (val));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2629 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2630 else if (arg.is_single_type ())
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2631 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2632 if (arg.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2633 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2634 FloatComplex val = arg.float_complex_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2635
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2636 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2637 retval = octave_value (new octave_float_complex (val));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2638 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2639 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2640 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2641 FloatComplexNDArray val = arg.float_complex_array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2642
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2643 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2644 retval = octave_value (new octave_float_complex_matrix (val));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2645 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2646 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2647 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2648 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2649 if (arg.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2650 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2651 Complex val = arg.complex_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2652
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2653 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2654 retval = octave_value (new octave_complex (val));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2655 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2656 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2657 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2658 ComplexNDArray val = arg.complex_array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2659
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2660 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2661 retval = octave_value (new octave_complex_matrix (val));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2662 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2663 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2664
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2665 if (error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2666 error ("complex: invalid conversion");
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2667 }
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2668 }
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2669 else if (nargin == 2)
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2670 {
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2671 octave_value re = args(0);
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2672 octave_value im = args(1);
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2673
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	2674 if (re.is_sparse_type () && im.is_sparse_type ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2675 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2676 const SparseMatrix re_val = re.sparse_matrix_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2677 const SparseMatrix im_val = im.sparse_matrix_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2678
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2679 if (!error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2680 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2681 if (re.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2682 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2683 SparseComplexMatrix result;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2684 if (re_val.nnz () == 0)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2685 result = Complex(0, 1) * SparseComplexMatrix (im_val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2686 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2687 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2688 result = SparseComplexMatrix (im_val.dims (), re_val (0));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2689 octave_idx_type nr = im_val.rows ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2690 octave_idx_type nc = im_val.cols ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2691
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2692 for (octave_idx_type j = 0; j < nc; j++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2693 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2694 octave_idx_type off = j * nr;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	2695 for (octave_idx_type i = im_val.cidx(j);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2696 i < im_val.cidx(j + 1); i++)
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	2697 result.data (im_val.ridx(i) + off) =
12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	2698 result.data (im_val.ridx(i) + off) +
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2699 Complex (0, im_val.data (i));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2700 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2701 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2702 retval = octave_value (new octave_sparse_complex_matrix (result));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2703 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2704 else if (im.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2705 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2706 SparseComplexMatrix result;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2707 if (im_val.nnz () == 0)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2708 result = SparseComplexMatrix (re_val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2709 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2710 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2711 result = SparseComplexMatrix (re_val.rows(), re_val.cols(), Complex(0, im_val (0)));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2712 octave_idx_type nr = re_val.rows ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2713 octave_idx_type nc = re_val.cols ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2714
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2715 for (octave_idx_type j = 0; j < nc; j++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2716 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2717 octave_idx_type off = j * nr;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	2718 for (octave_idx_type i = re_val.cidx(j);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2719 i < re_val.cidx(j + 1); i++)
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	2720 result.data (re_val.ridx(i) + off) =
12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	2721 result.data (re_val.ridx(i) + off) +
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2722 re_val.data (i);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2723 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2724 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2725 retval = octave_value (new octave_sparse_complex_matrix (result));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2726 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2727 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2728 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2729 if (re_val.dims () == im_val.dims ())
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2730 {
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	2731 SparseComplexMatrix result = SparseComplexMatrix(re_val)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2732 + Complex(0, 1) * SparseComplexMatrix (im_val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2733 retval = octave_value (new octave_sparse_complex_matrix (result));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2734 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2735 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2736 error ("complex: dimension mismatch");
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2737 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2738 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2739 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	2740 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	2741 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2742 if (re.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2743 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2744 float re_val = re.float_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2745
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2746 if (im.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2747 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2748 float im_val = im.double_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2749
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2750 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2751 retval = octave_value (new octave_float_complex (FloatComplex (re_val, im_val)));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2752 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2753 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2754 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2755 const FloatNDArray im_val = im.float_array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2756
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2757 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2758 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2759 FloatComplexNDArray result (im_val.dims (), FloatComplex ());
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2760
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2761 for (octave_idx_type i = 0; i < im_val.numel (); i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2762 result.xelem (i) = FloatComplex (re_val, im_val(i));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2763
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2764 retval = octave_value (new octave_float_complex_matrix (result));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2765 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2766 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2767 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2768 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2769 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2770 const FloatNDArray re_val = re.float_array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2771
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2772 if (im.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2773 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2774 float im_val = im.float_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2775
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2776 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2777 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2778 FloatComplexNDArray result (re_val.dims (), FloatComplex ());
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2779
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2780 for (octave_idx_type i = 0; i < re_val.numel (); i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2781 result.xelem (i) = FloatComplex (re_val(i), im_val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2782
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2783 retval = octave_value (new octave_float_complex_matrix (result));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2784 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2785 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2786 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2787 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2788 const FloatNDArray im_val = im.float_array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2789
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2790 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2791 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2792 if (re_val.dims () == im_val.dims ())
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2793 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2794 FloatComplexNDArray result (re_val.dims (), FloatComplex ());
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2795
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2796 for (octave_idx_type i = 0; i < re_val.numel (); i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2797 result.xelem (i) = FloatComplex (re_val(i), im_val(i));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2798
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2799 retval = octave_value (new octave_float_complex_matrix (result));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2800 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2801 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2802 error ("complex: dimension mismatch");
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2803 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2804 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2805 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2806 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	2807 else if (re.numel () == 1)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2808 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2809 double re_val = re.double_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2810
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2811 if (im.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2812 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2813 double im_val = im.double_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2814
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2815 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2816 retval = octave_value (new octave_complex (Complex (re_val, im_val)));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2817 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2818 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2819 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2820 const NDArray im_val = im.array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2821
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2822 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2823 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2824 ComplexNDArray result (im_val.dims (), Complex ());
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2825
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2826 for (octave_idx_type i = 0; i < im_val.numel (); i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2827 result.xelem (i) = Complex (re_val, im_val(i));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2828
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2829 retval = octave_value (new octave_complex_matrix (result));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2830 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2831 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2832 }
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2833 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2834 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2835 const NDArray re_val = re.array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2836
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2837 if (im.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2838 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2839 double im_val = im.double_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2840
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2841 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2842 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2843 ComplexNDArray result (re_val.dims (), Complex ());
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2844
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2845 for (octave_idx_type i = 0; i < re_val.numel (); i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2846 result.xelem (i) = Complex (re_val(i), im_val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2847
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2848 retval = octave_value (new octave_complex_matrix (result));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2849 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2850 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2851 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2852 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2853 const NDArray im_val = im.array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2854
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2855 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2856 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2857 if (re_val.dims () == im_val.dims ())
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2858 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2859 ComplexNDArray result (re_val.dims (), Complex ());
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2860
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2861 for (octave_idx_type i = 0; i < re_val.numel (); i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2862 result.xelem (i) = Complex (re_val(i), im_val(i));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2863
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2864 retval = octave_value (new octave_complex_matrix (result));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2865 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2866 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2867 error ("complex: dimension mismatch");
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2868 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2869 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2870 }
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2871
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2872 if (error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2873 error ("complex: invalid conversion");
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2874 }
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2875 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2876 print_usage ();
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2877
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2878 return retval;
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2879 }
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	2880
3258 4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	2881 DEFUN (isreal, args, ,
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	2882 "-- texinfo --\n\
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	2883 @deftypefn {Built-in Function} {} isreal (@var{x})\n\
10291 fc879f361bda make isreal matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10290 diff changeset	2884 Return true if @var{x} is a non-complex matrix or scalar.\n\
10711 fbd7843974fa Periodic grammar check of documentation files to ensure common format. Rik <octave@nomad.inbox5.com> parents: 10707 diff changeset	2885 For compatibility with @sc{matlab}, this includes logical and character\n\
10291 fc879f361bda make isreal matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10290 diff changeset	2886 matrices.\n\
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	2887 @seealso{iscomplex, isnumeric}\n\
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	2888 @end deftypefn")
3258 4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	2889 {
4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	2890 octave_value retval;
4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	2891
4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	2892 if (args.length () == 1)
4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	2893 retval = args(0).is_real_type ();
4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	2894 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2895 print_usage ();
3258 4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	2896
4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	2897 return retval;
4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	2898 }
4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	2899
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	2900 DEFUN (isempty, args, ,
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2901 "-- texinfo --\n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2902 @deftypefn {Built-in Function} {} isempty (@var{a})\n\
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	2903 Return true if @var{a} is an empty matrix (any one of its dimensions is\n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	2904 zero). Otherwise, return false.\n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	2905 @seealso{isnull}\n\
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2906 @end deftypefn")
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	2907 {
4233 ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe] jwe parents: 4176 diff changeset	2908 octave_value retval = false;
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	2909
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	2910 if (args.length () == 1)
4559 802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2911 retval = args(0).is_empty ();
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	2912 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2913 print_usage ();
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	2914
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	2915 return retval;
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	2916 }
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	2917
3206 d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	2918 DEFUN (isnumeric, args, ,
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	2919 "-- texinfo --\n\
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	2920 @deftypefn {Built-in Function} {} isnumeric (@var{x})\n\
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	2921 Return true if @var{x} is a numeric object, i.e., an integer, real, or\n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	2922 complex array. Logical and character arrays are not considered to be\n\
a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	2923 numeric.\n\
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	2924 @seealso{isinteger, isfloat, isreal, iscomplex, islogical, ischar, iscell, isstruct}\n\
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	2925 @end deftypefn")
3206 d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	2926 {
d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	2927 octave_value retval;
d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	2928
d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	2929 if (args.length () == 1)
3258 4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	2930 retval = args(0).is_numeric_type ();
3206 d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	2931 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2932 print_usage ();
3206 d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	2933
d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	2934 return retval;
d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	2935 }
d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	2936
11435 20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	2937 /*
20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	2938
20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	2939 %!assert (isnumeric(1), true)
20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	2940 %!assert (isnumeric(1i), true)
20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	2941 %!assert (isnumeric([1,1]), true)
20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	2942 %!assert (isnumeric(single(1)), true)
20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	2943 %!assert (isnumeric(single(1i)), true)
20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	2944 %!assert (isnumeric(single([1,1])), true)
20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	2945 %!assert (isnumeric(int8(1)), true)
20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	2946 %!assert (isnumeric(uint8([1,1])), true)
20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	2947 %!assert (isnumeric("Hello World"), false)
20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	2948 %!assert (isnumeric(true), false)
20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	2949 %!assert (isnumeric(false), false)
20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	2950 %!assert (isnumeric([true, false]), false)
20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	2951 %!assert (isnumeric(sparse ([true, false])), false)
20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	2952
20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	2953 */
20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	2954
4028 ef75c970c8f5 [project @ 2002-08-09 07:19:02 by jwe] jwe parents: 4025 diff changeset	2955 DEFUN (ismatrix, args, ,
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 3307 diff changeset	2956 "-- texinfo --\n\
4028 ef75c970c8f5 [project @ 2002-08-09 07:19:02 by jwe] jwe parents: 4025 diff changeset	2957 @deftypefn {Built-in Function} {} ismatrix (@var{a})\n\
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	2958 Return true if @var{a} is a numeric, logical, or character matrix.\n\
11591 1d13679b587e Use @nospell macro on certain words in docstrings. Rik <octave@nomad.inbox5.com> parents: 11590 diff changeset	2959 Scalars (1x1 matrices) and vectors (@nospell{1xN} or @nospell{Nx1} matrices)\n\
1d13679b587e Use @nospell macro on certain words in docstrings. Rik <octave@nomad.inbox5.com> parents: 11590 diff changeset	2960 are subsets of the more general N-dimensional matrix and @code{ismatrix}\n\
1d13679b587e Use @nospell macro on certain words in docstrings. Rik <octave@nomad.inbox5.com> parents: 11590 diff changeset	2961 will return true for these objects as well.\n\
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	2962 @seealso{isscalar, isvector, iscell, isstruct, issparse}\n\
3333 15cddaacbc2d [project @ 1999-11-03 19:53:59 by jwe] jwe parents: 3322 diff changeset	2963 @end deftypefn")
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	2964 {
4233 ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe] jwe parents: 4176 diff changeset	2965 octave_value retval = false;
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	2966
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	2967 if (args.length () == 1)
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	2968 {
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	2969 octave_value arg = args(0);
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	2970
9866 b5aa5d9ee6b9 make ismatrix consistent for empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 9858 diff changeset	2971 retval = arg.is_matrix_type () \|\| arg.is_scalar_type () \|\| arg.is_range ();
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	2972 }
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	2973 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2974 print_usage ();
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	2975
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	2976 return retval;
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	2977 }
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	2978
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	2979 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	2980
9866 b5aa5d9ee6b9 make ismatrix consistent for empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 9858 diff changeset	2981 %!assert(ismatrix ([]));
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	2982 %!assert(ismatrix (1));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	2983 %!assert(ismatrix ([1, 2, 3]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	2984 %!assert(ismatrix ([1, 2; 3, 4]));
9866 b5aa5d9ee6b9 make ismatrix consistent for empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 9858 diff changeset	2985 %!assert(ismatrix (zeros (3, 2, 4)));
b5aa5d9ee6b9 make ismatrix consistent for empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 9858 diff changeset	2986
b5aa5d9ee6b9 make ismatrix consistent for empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 9858 diff changeset	2987 %!assert(ismatrix (single([])));
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	2988 %!assert(ismatrix (single(1)));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	2989 %!assert(ismatrix (single([1, 2, 3])));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	2990 %!assert(ismatrix (single([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	2991
10024 184060864627 allow ismatrix on character matrices Jaroslav Hajek <highegg@gmail.com> parents: 10002 diff changeset	2992 %!assert(ismatrix ("t"));
184060864627 allow ismatrix on character matrices Jaroslav Hajek <highegg@gmail.com> parents: 10002 diff changeset	2993 %!assert(ismatrix ("test"));
184060864627 allow ismatrix on character matrices Jaroslav Hajek <highegg@gmail.com> parents: 10002 diff changeset	2994 %!assert(ismatrix (["test"; "ing"]));
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	2995
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	2996 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	2997 %! s.a = 1;
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	2998 %! assert(ismatrix (s), false);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	2999
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3000 %!error <Invalid call to ismatrix.*> ismatrix ();
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3001 %!error <Invalid call to ismatrix.*> ismatrix ([1, 2; 3, 4], 2);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3002
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3003 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3004
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	3005 static octave_value
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3006 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	3007 {
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	3008 octave_value retval;
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3009
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3010 int nargin = args.length ();
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3011
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3012 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	3013
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3014 dim_vector dims (1, 1);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	3015
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	3016 if (nargin > 0 && args(nargin-1).is_string ())
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	3017 {
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3018 std::string nm = args(nargin-1).string_value ();
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	3019 nargin--;
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	3020
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3021 dt = oct_data_conv::string_to_data_type (nm);
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3022
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3023 if (error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3024 return retval;
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	3025 }
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	3026
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3027 switch (nargin)
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3028 {
712 36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	3029 case 0:
36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	3030 break;
777 a2f9d3fd720c [project @ 1994-10-07 14:01:53 by jwe] jwe parents: 767 diff changeset	3031
610 14b2a186a5c0 [project @ 1994-08-14 00:55:49 by jwe] jwe parents: 597 diff changeset	3032 case 1:
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	3033 get_dimensions (args(0), fcn, dims);
610 14b2a186a5c0 [project @ 1994-08-14 00:55:49 by jwe] jwe parents: 597 diff changeset	3034 break;
777 a2f9d3fd720c [project @ 1994-10-07 14:01:53 by jwe] jwe parents: 767 diff changeset	3035
4563 742993a501b9 [project @ 2003-10-29 06:25:12 by jwe] jwe parents: 4559 diff changeset	3036 default:
742993a501b9 [project @ 2003-10-29 06:25:12 by jwe] jwe parents: 4559 diff changeset	3037 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3038 dims.resize (nargin);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3039
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3040 for (int i = 0; i < nargin; i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3041 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3042 dims(i) = args(i).is_empty () ? 0 : args(i).idx_type_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3043
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3044 if (error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3045 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3046 error ("%s: expecting scalar integer arguments", fcn);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3047 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3048 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3049 }
4563 742993a501b9 [project @ 2003-10-29 06:25:12 by jwe] jwe parents: 4559 diff changeset	3050 }
742993a501b9 [project @ 2003-10-29 06:25:12 by jwe] jwe parents: 4559 diff changeset	3051 break;
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	3052 }
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	3053
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	3054 if (! error_state)
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	3055 {
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3056 dims.chop_trailing_singletons ();
4565 1db951a4fcd5 [project @ 2003-10-29 13:49:30 by jwe] jwe parents: 4563 diff changeset	3057
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	3058 check_dimensions (dims, fcn);
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	3059
5775 ace8d8d26933 [project @ 2006-04-24 19:13:06 by jwe] jwe parents: 5747 diff changeset	3060 // FIXME -- perhaps this should be made extensible by
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3061 // using the class name to lookup a function to call to create
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3062 // the new value.
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3063
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3064 // Note that automatic narrowing will handle conversion from
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3065 // NDArray to scalar.
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3066
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	3067 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3068 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3069 switch (dt)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3070 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3071 case oct_data_conv::dt_int8:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3072 retval = int8NDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3073 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3074
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3075 case oct_data_conv::dt_uint8:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3076 retval = uint8NDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3077 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3078
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3079 case oct_data_conv::dt_int16:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3080 retval = int16NDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3081 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3082
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3083 case oct_data_conv::dt_uint16:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3084 retval = uint16NDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3085 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3086
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3087 case oct_data_conv::dt_int32:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3088 retval = int32NDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3089 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3090
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3091 case oct_data_conv::dt_uint32:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3092 retval = uint32NDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3093 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3094
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3095 case oct_data_conv::dt_int64:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3096 retval = int64NDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3097 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3098
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3099 case oct_data_conv::dt_uint64:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3100 retval = uint64NDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3101 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3102
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3103 case oct_data_conv::dt_single:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3104 retval = FloatNDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3105 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3106
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3107 case oct_data_conv::dt_double:
8972 5fa53d1b6247 more indexing optimizations Jaroslav Hajek <highegg@gmail.com> parents: 8947 diff changeset	3108 {
5fa53d1b6247 more indexing optimizations Jaroslav Hajek <highegg@gmail.com> parents: 8947 diff changeset	3109 if (val == 1 && dims.length () == 2 && dims (0) == 1)
5fa53d1b6247 more indexing optimizations Jaroslav Hajek <highegg@gmail.com> parents: 8947 diff changeset	3110 retval = Range (1.0, 0.0, dims (1)); // packed form
5fa53d1b6247 more indexing optimizations Jaroslav Hajek <highegg@gmail.com> parents: 8947 diff changeset	3111 else
5fa53d1b6247 more indexing optimizations Jaroslav Hajek <highegg@gmail.com> parents: 8947 diff changeset	3112 retval = NDArray (dims, val);
5fa53d1b6247 more indexing optimizations Jaroslav Hajek <highegg@gmail.com> parents: 8947 diff changeset	3113 }
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3114 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3115
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3116 case oct_data_conv::dt_logical:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3117 retval = boolNDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3118 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3119
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3120 default:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3121 error ("%s: invalid class name", fcn);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3122 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3123 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3124 }
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3125 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3126
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3127 return retval;
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3128 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3129
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3130 static octave_value
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	3131 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	3132 const char *fcn)
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3133 {
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3134 octave_value retval;
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3135
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3136 int nargin = args.length ();
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3137
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3138 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	3139
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3140 dim_vector dims (1, 1);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	3141
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3142 if (nargin > 0 && args(nargin-1).is_string ())
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3143 {
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3144 std::string nm = args(nargin-1).string_value ();
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3145 nargin--;
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3146
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3147 dt = oct_data_conv::string_to_data_type (nm);
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3148
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3149 if (error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3150 return retval;
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3151 }
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3152
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3153 switch (nargin)
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3154 {
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3155 case 0:
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3156 break;
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3157
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3158 case 1:
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3159 get_dimensions (args(0), fcn, dims);
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3160 break;
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3161
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3162 default:
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3163 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3164 dims.resize (nargin);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3165
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3166 for (int i = 0; i < nargin; i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3167 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3168 dims(i) = args(i).is_empty () ? 0 : args(i).idx_type_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3169
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3170 if (error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3171 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3172 error ("%s: expecting scalar integer arguments", fcn);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3173 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3174 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3175 }
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3176 }
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3177 break;
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3178 }
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3179
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3180 if (! error_state)
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3181 {
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3182 dims.chop_trailing_singletons ();
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3183
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3184 check_dimensions (dims, fcn);
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3185
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3186 // Note that automatic narrowing will handle conversion from
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3187 // NDArray to scalar.
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3188
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3189 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3190 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3191 switch (dt)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3192 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3193 case oct_data_conv::dt_single:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3194 retval = FloatNDArray (dims, fval);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3195 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3196
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3197 case oct_data_conv::dt_double:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3198 retval = NDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3199 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3200
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3201 default:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3202 error ("%s: invalid class name", fcn);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3203 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3204 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3205 }
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3206 }
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3207
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3208 return retval;
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3209 }
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3210
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3211 static octave_value
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3212 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	3213 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3214 octave_value retval;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3215
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3216 int nargin = args.length ();
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3217
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3218 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	3219
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3220 dim_vector dims (1, 1);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	3221
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3222 if (nargin > 0 && args(nargin-1).is_string ())
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3223 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3224 std::string nm = args(nargin-1).string_value ();
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3225 nargin--;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3226
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3227 dt = oct_data_conv::string_to_data_type (nm);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3228
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3229 if (error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3230 return retval;
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3231 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3232
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3233 switch (nargin)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3234 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3235 case 0:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3236 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3237
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3238 case 1:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3239 get_dimensions (args(0), fcn, dims);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3240 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3241
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3242 default:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3243 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3244 dims.resize (nargin);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3245
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3246 for (int i = 0; i < nargin; i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3247 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3248 dims(i) = args(i).is_empty () ? 0 : args(i).idx_type_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3249
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3250 if (error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3251 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3252 error ("%s: expecting scalar integer arguments", fcn);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3253 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3254 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3255 }
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3256 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3257 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3258 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3259
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3260 if (! error_state)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3261 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3262 dims.chop_trailing_singletons ();
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3263
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3264 check_dimensions (dims, fcn);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3265
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3266 // Note that automatic narrowing will handle conversion from
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3267 // NDArray to scalar.
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3268
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3269 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3270 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3271 switch (dt)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3272 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3273 case oct_data_conv::dt_single:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3274 retval = FloatNDArray (dims, static_cast <float> (val));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3275 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3276
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3277 case oct_data_conv::dt_double:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3278 retval = NDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3279 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3280
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3281 default:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3282 error ("%s: invalid class name", fcn);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3283 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3284 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3285 }
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3286 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3287
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3288 return retval;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3289 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3290
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3291 static octave_value
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3292 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	3293 const char *fcn)
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3294 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3295 octave_value retval;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3296
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3297 int nargin = args.length ();
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3298
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3299 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	3300
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3301 dim_vector dims (1, 1);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	3302
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3303 if (nargin > 0 && args(nargin-1).is_string ())
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3304 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3305 std::string nm = args(nargin-1).string_value ();
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3306 nargin--;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3307
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3308 dt = oct_data_conv::string_to_data_type (nm);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3309
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3310 if (error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3311 return retval;
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3312 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3313
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3314 switch (nargin)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3315 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3316 case 0:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3317 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3318
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3319 case 1:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3320 get_dimensions (args(0), fcn, dims);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3321 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3322
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3323 default:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3324 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3325 dims.resize (nargin);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3326
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3327 for (int i = 0; i < nargin; i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3328 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3329 dims(i) = args(i).is_empty () ? 0 : args(i).idx_type_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3330
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3331 if (error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3332 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3333 error ("%s: expecting scalar integer arguments", fcn);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3334 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3335 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3336 }
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3337 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3338 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3339 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3340
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3341 if (! error_state)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3342 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3343 dims.chop_trailing_singletons ();
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3344
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3345 check_dimensions (dims, fcn);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3346
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3347 // Note that automatic narrowing will handle conversion from
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3348 // NDArray to scalar.
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3349
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3350 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3351 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3352 switch (dt)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3353 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3354 case oct_data_conv::dt_single:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3355 retval = FloatComplexNDArray (dims, static_cast<FloatComplex> (val));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3356 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3357
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3358 case oct_data_conv::dt_double:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3359 retval = ComplexNDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3360 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3361
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3362 default:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3363 error ("%s: invalid class name", fcn);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3364 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3365 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3366 }
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3367 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3368
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3369 return retval;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3370 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3371
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3372 static octave_value
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3373 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	3374 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3375 octave_value retval;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3376
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3377 int nargin = args.length ();
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3378
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3379 dim_vector dims (1, 1);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	3380
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3381 switch (nargin)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3382 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3383 case 0:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3384 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3385
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3386 case 1:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3387 get_dimensions (args(0), fcn, dims);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3388 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3389
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3390 default:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3391 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3392 dims.resize (nargin);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3393
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3394 for (int i = 0; i < nargin; i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3395 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3396 dims(i) = args(i).is_empty () ? 0 : args(i).idx_type_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3397
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3398 if (error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3399 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3400 error ("%s: expecting scalar integer arguments", fcn);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3401 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3402 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3403 }
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3404 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3405 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3406 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3407
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3408 if (! error_state)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3409 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3410 dims.chop_trailing_singletons ();
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3411
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3412 check_dimensions (dims, fcn);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3413
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3414 // Note that automatic narrowing will handle conversion from
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3415 // NDArray to scalar.
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3416
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3417 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3418 retval = boolNDArray (dims, val);
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3419 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3420
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3421 return retval;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3422 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3423
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	3424 DEFUN (ones, args, ,
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	3425 "-- texinfo --\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	3426 @deftypefn {Built-in Function} {} ones (@var{x})\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	3427 @deftypefnx {Built-in Function} {} ones (@var{n}, @var{m})\n\
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	3428 @deftypefnx {Built-in Function} {} ones (@var{n}, @var{m}, @var{k}, @dots{})\n\
7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	3429 @deftypefnx {Built-in Function} {} ones (@dots{}, @var{class})\n\
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	3430 Return a matrix or N-dimensional array whose elements are all 1.\n\
9428 b317debeb828 data.cc (Fones, Fzeros, Ftrue, Ffalse): update docstring John W. Eaton <jwe@octave.org> parents: 9351 diff changeset	3431 If invoked with a single scalar integer argument, return a square\n\
b317debeb828 data.cc (Fones, Fzeros, Ftrue, Ffalse): update docstring John W. Eaton <jwe@octave.org> parents: 9351 diff changeset	3432 matrix of the specified size. If invoked with two or more scalar\n\
b317debeb828 data.cc (Fones, Fzeros, Ftrue, Ffalse): update docstring John W. Eaton <jwe@octave.org> parents: 9351 diff changeset	3433 integer arguments, or a vector of integer values, return an array with\n\
b317debeb828 data.cc (Fones, Fzeros, Ftrue, Ffalse): update docstring John W. Eaton <jwe@octave.org> parents: 9351 diff changeset	3434 given dimensions.\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	3435 \n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	3436 If you need to create a matrix whose values are all the same, you should\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	3437 use an expression like\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	3438 \n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	3439 @example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	3440 val_matrix = val * ones (n, m)\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	3441 @end example\n\
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	3442 \n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	3443 The optional argument @var{class} specifies the class of the return array\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	3444 and defaults to double. For example:\n\
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	3445 \n\
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	3446 @example\n\
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	3447 val = ones (n,m, \"uint8\")\n\
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	3448 @end example\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	3449 @seealso{zeros}\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	3450 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3451 {
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3452 return fill_matrix (args, 1, "ones");
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3453 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3454
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3455 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3456
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3457 %!assert(ones (3), [1, 1, 1; 1, 1, 1; 1, 1, 1]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3458 %!assert(ones (2, 3), [1, 1, 1; 1, 1, 1]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3459 %!assert(ones (3, 2), [1, 1; 1, 1; 1, 1]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3460 %!assert(size (ones (3, 4, 5)), [3, 4, 5]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3461
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3462 %!assert(ones (3,'single'), single([1, 1, 1; 1, 1, 1; 1, 1, 1]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3463 %!assert(ones (2, 3,'single'), single([1, 1, 1; 1, 1, 1]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3464 %!assert(ones (3, 2,'single'), single([1, 1; 1, 1; 1, 1]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3465 %!assert(size (ones (3, 4, 5, 'single')), [3, 4, 5]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3466
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3467 %!assert(ones (3,'int8'), int8([1, 1, 1; 1, 1, 1; 1, 1, 1]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3468 %!assert(ones (2, 3,'int8'), int8([1, 1, 1; 1, 1, 1]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3469 %!assert(ones (3, 2,'int8'), int8([1, 1; 1, 1; 1, 1]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3470 %!assert(size (ones (3, 4, 5, 'int8')), [3, 4, 5]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3471
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3472 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3473
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	3474 DEFUN (zeros, args, ,
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	3475 "-- texinfo --\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	3476 @deftypefn {Built-in Function} {} zeros (@var{x})\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	3477 @deftypefnx {Built-in Function} {} zeros (@var{n}, @var{m})\n\
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	3478 @deftypefnx {Built-in Function} {} zeros (@var{n}, @var{m}, @var{k}, @dots{})\n\
7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	3479 @deftypefnx {Built-in Function} {} zeros (@dots{}, @var{class})\n\
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	3480 Return a matrix or N-dimensional array whose elements are all 0.\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	3481 If invoked with a single scalar integer argument, return a square\n\
a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	3482 matrix of the specified size. If invoked with two or more scalar\n\
a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	3483 integer arguments, or a vector of integer values, return an array with\n\
a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	3484 given dimensions.\n\
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	3485 \n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	3486 The optional argument @var{class} specifies the class of the return array\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	3487 and defaults to double. For example:\n\
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	3488 \n\
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	3489 @example\n\
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	3490 val = zeros (n,m, \"uint8\")\n\
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	3491 @end example\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	3492 @seealso{ones}\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	3493 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3494 {
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3495 return fill_matrix (args, 0, "zeros");
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3496 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3497
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3498 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3499
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3500 %!assert(zeros (3), [0, 0, 0; 0, 0, 0; 0, 0, 0]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3501 %!assert(zeros (2, 3), [0, 0, 0; 0, 0, 0]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3502 %!assert(zeros (3, 2), [0, 0; 0, 0; 0, 0]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3503 %!assert(size (zeros (3, 4, 5)), [3, 4, 5]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3504
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3505 %!assert(zeros (3,'single'), single([0, 0, 0; 0, 0, 0; 0, 0, 0]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3506 %!assert(zeros (2, 3,'single'), single([0, 0, 0; 0, 0, 0]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3507 %!assert(zeros (3, 2,'single'), single([0, 0; 0, 0; 0, 0]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3508 %!assert(size (zeros (3, 4, 5, 'single')), [3, 4, 5]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3509
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3510 %!assert(zeros (3,'int8'), int8([0, 0, 0; 0, 0, 0; 0, 0, 0]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3511 %!assert(zeros (2, 3,'int8'), int8([0, 0, 0; 0, 0, 0]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3512 %!assert(zeros (3, 2,'int8'), int8([0, 0; 0, 0; 0, 0]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3513 %!assert(size (zeros (3, 4, 5, 'int8')), [3, 4, 5]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3514
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3515 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3516
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3517 DEFUN (Inf, args, ,
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3518 "-- texinfo --\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3519 @deftypefn {Built-in Function} {} Inf\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3520 @deftypefnx {Built-in Function} {} Inf (@var{n})\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3521 @deftypefnx {Built-in Function} {} Inf (@var{n}, @var{m})\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3522 @deftypefnx {Built-in Function} {} Inf (@var{n}, @var{m}, @var{k}, @dots{})\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3523 @deftypefnx {Built-in Function} {} Inf (@dots{}, @var{class})\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3524 Return a scalar, matrix or N-dimensional array whose elements are all equal\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3525 to the IEEE representation for positive infinity.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3526 \n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3527 Infinity is produced when results are too large to be represented using the\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3528 the IEEE floating point format for numbers. Two common examples which\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3529 produce infinity are division by zero and overflow.\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	3530 \n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3531 @example\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3532 @group\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3533 [1/0 e^800]\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3534 @result{}\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3535 Inf Inf\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3536 @end group\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3537 @end example\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3538 \n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3539 When called with no arguments, return a scalar with the value @samp{Inf}.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3540 When called with a single argument, return a square matrix with the dimension\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3541 specified. When called with more than one scalar argument the first two\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3542 arguments are taken as the number of rows and columns and any further\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3543 arguments specify additional matrix dimensions.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3544 The optional argument @var{class} specifies the return type and may be\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3545 either \"double\" or \"single\".\n\
9308 f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	3546 @seealso{isinf}\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3547 @end deftypefn")
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3548 {
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	3549 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	3550 lo_ieee_float_inf_value (), "Inf");
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3551 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3552
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3553 DEFALIAS (inf, Inf);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3554
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3555 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3556
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3557 %!assert(inf (3), [Inf, Inf, Inf; Inf, Inf, Inf; Inf, Inf, Inf]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3558 %!assert(inf (2, 3), [Inf, Inf, Inf; Inf, Inf, Inf]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3559 %!assert(inf (3, 2), [Inf, Inf; Inf, Inf; Inf, Inf]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3560 %!assert(size (inf (3, 4, 5)), [3, 4, 5]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3561
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3562 %!assert(inf (3,'single'), single([Inf, Inf, Inf; Inf, Inf, Inf; Inf, Inf, Inf]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3563 %!assert(inf (2, 3,'single'), single([Inf, Inf, Inf; Inf, Inf, Inf]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3564 %!assert(inf (3, 2,'single'), single([Inf, Inf; Inf, Inf; Inf, Inf]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3565 %!assert(size (inf (3, 4, 5, 'single')), [3, 4, 5]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3566
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3567 %!error(inf (3,'int8'));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3568 %!error(inf (2, 3,'int8'));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3569 %!error(inf (3, 2,'int8'));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3570 %!error(inf (3, 4, 5, 'int8'));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3571
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3572 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3573
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3574 DEFUN (NaN, args, ,
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3575 "-- texinfo --\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3576 @deftypefn {Built-in Function} {} NaN\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3577 @deftypefnx {Built-in Function} {} NaN (@var{n})\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3578 @deftypefnx {Built-in Function} {} NaN (@var{n}, @var{m})\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3579 @deftypefnx {Built-in Function} {} NaN (@var{n}, @var{m}, @var{k}, @dots{})\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3580 @deftypefnx {Built-in Function} {} NaN (@dots{}, @var{class})\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3581 Return a scalar, matrix, or N-dimensional array whose elements are all equal\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3582 to the IEEE symbol NaN (Not a Number).\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3583 NaN is the result of operations which do not produce a well defined numerical\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3584 result. Common operations which produce a NaN are arithmetic with infinity\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3585 @tex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3586 ($\\infty - \\infty$), zero divided by zero ($0/0$),\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3587 @end tex\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 8487 diff changeset	3588 @ifnottex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3589 (Inf - Inf), zero divided by zero (0/0),\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 8487 diff changeset	3590 @end ifnottex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3591 and any operation involving another NaN value (5 + NaN).\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3592 \n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3593 Note that NaN always compares not equal to NaN (NaN != NaN). This behavior\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3594 is specified by the IEEE standard for floating point arithmetic. To\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3595 find NaN values, use the @code{isnan} function.\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3596 \n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3597 When called with no arguments, return a scalar with the value @samp{NaN}.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3598 When called with a single argument, return a square matrix with the dimension\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3599 specified. When called with more than one scalar argument the first two\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3600 arguments are taken as the number of rows and columns and any further\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3601 arguments specify additional matrix dimensions.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3602 The optional argument @var{class} specifies the return type and may be\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3603 either \"double\" or \"single\".\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3604 @seealso{isnan}\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3605 @end deftypefn")
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3606 {
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	3607 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	3608 lo_ieee_float_nan_value (), "NaN");
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3609 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3610
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3611 DEFALIAS (nan, NaN);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3612
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	3613 /*
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3614 %!assert(NaN (3), [NaN, NaN, NaN; NaN, NaN, NaN; NaN, NaN, NaN]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3615 %!assert(NaN (2, 3), [NaN, NaN, NaN; NaN, NaN, NaN]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3616 %!assert(NaN (3, 2), [NaN, NaN; NaN, NaN; NaN, NaN]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3617 %!assert(size (NaN (3, 4, 5)), [3, 4, 5]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3618
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3619 %!assert(NaN (3,'single'), single([NaN, NaN, NaN; NaN, NaN, NaN; NaN, NaN, NaN]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3620 %!assert(NaN (2, 3,'single'), single([NaN, NaN, NaN; NaN, NaN, NaN]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3621 %!assert(NaN (3, 2,'single'), single([NaN, NaN; NaN, NaN; NaN, NaN]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3622 %!assert(size (NaN (3, 4, 5, 'single')), [3, 4, 5]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3623
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3624 %!error(NaN (3,'int8'));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3625 %!error(NaN (2, 3,'int8'));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3626 %!error(NaN (3, 2,'int8'));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3627 %!error(NaN (3, 4, 5, 'int8'));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3628
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3629 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3630
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3631 DEFUN (e, args, ,
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3632 "-- texinfo --\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3633 @deftypefn {Built-in Function} {} e\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3634 @deftypefnx {Built-in Function} {} e (@var{n})\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3635 @deftypefnx {Built-in Function} {} e (@var{n}, @var{m})\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3636 @deftypefnx {Built-in Function} {} e (@var{n}, @var{m}, @var{k}, @dots{})\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3637 @deftypefnx {Built-in Function} {} e (@dots{}, @var{class})\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3638 Return a scalar, matrix, or N-dimensional array whose elements are all equal\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3639 to the base of natural logarithms. The constant\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3640 @tex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3641 $e$ satisfies the equation $\\log (e) = 1$.\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3642 @end tex\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 8487 diff changeset	3643 @ifnottex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3644 @samp{e} satisfies the equation @code{log} (e) = 1.\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 8487 diff changeset	3645 @end ifnottex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3646 \n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3647 When called with no arguments, return a scalar with the value @math{e}. When\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3648 called with a single argument, return a square matrix with the dimension\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3649 specified. When called with more than one scalar argument the first two\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3650 arguments are taken as the number of rows and columns and any further\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3651 arguments specify additional matrix dimensions.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3652 The optional argument @var{class} specifies the return type and may be\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3653 either \"double\" or \"single\".\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3654 @end deftypefn")
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3655 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3656 #if defined (M_E)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3657 double e_val = M_E;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3658 #else
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3659 double e_val = exp (1.0);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3660 #endif
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3661
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3662 return fill_matrix (args, e_val, "e");
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3663 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3664
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3665 DEFUN (eps, args, ,
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3666 "-- texinfo --\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3667 @deftypefn {Built-in Function} {} eps\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3668 @deftypefnx {Built-in Function} {} eps (@var{x})\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3669 @deftypefnx {Built-in Function} {} eps (@var{n}, @var{m})\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3670 @deftypefnx {Built-in Function} {} eps (@var{n}, @var{m}, @var{k}, @dots{})\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3671 @deftypefnx {Built-in Function} {} eps (@dots{}, @var{class})\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3672 Return a scalar, matrix or N-dimensional array whose elements are all eps,\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3673 the machine precision. More precisely, @code{eps} is the relative spacing\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3674 between any two adjacent numbers in the machine's floating point system.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3675 This number is obviously system dependent. On machines that support IEEE\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3676 floating point arithmetic, @code{eps} is approximately\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3677 @tex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3678 $2.2204\\times10^{-16}$ for double precision and $1.1921\\times10^{-7}$\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3679 @end tex\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 8487 diff changeset	3680 @ifnottex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3681 2.2204e-16 for double precision and 1.1921e-07\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 8487 diff changeset	3682 @end ifnottex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3683 for single precision.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3684 \n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3685 When called with no arguments, return a scalar with the value\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3686 @code{eps(1.0)}.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3687 Given a single argument @var{x}, return the distance between @var{x} and\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3688 the next largest value.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3689 When called with more than one argument the first two arguments are taken as\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3690 the number of rows and columns and any further\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3691 arguments specify additional matrix dimensions.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3692 The optional argument @var{class} specifies the return type and may be\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3693 either \"double\" or \"single\".\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3694 @end deftypefn")
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3695 {
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3696 int nargin = args.length ();
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3697 octave_value retval;
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3698
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3699 if (nargin == 1 && ! args(0).is_string ())
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3700 {
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3701 if (args(0).is_single_type ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3702 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3703 float val = args(0).float_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3704
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3705 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3706 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3707 val = ::fabsf(val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3708 if (xisnan (val) \|\| xisinf (val))
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	3709 retval = fill_matrix (octave_value ("single"),
12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	3710 lo_ieee_nan_value (),
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3711 lo_ieee_float_nan_value (), "eps");
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3712 else if (val < FLT_MIN)
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	3713 retval = fill_matrix (octave_value ("single"), 0e0,
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3714 powf (2.0, -149e0), "eps");
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3715 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3716 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3717 int expon;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3718 frexpf (val, &expon);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	3719 val = std::pow (static_cast <float> (2.0),
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3720 static_cast <float> (expon - 24));
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	3721 retval = fill_matrix (octave_value ("single"), DBL_EPSILON,
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3722 val, "eps");
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3723 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3724 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3725 }
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3726 else
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 double val = args(0).double_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3729
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3730 if (! error_state)
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 val = ::fabs(val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3733 if (xisnan (val) \|\| xisinf (val))
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	3734 retval = fill_matrix (octave_value_list (),
12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	3735 lo_ieee_nan_value (),
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3736 lo_ieee_float_nan_value (), "eps");
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3737 else if (val < DBL_MIN)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3738 retval = fill_matrix (octave_value_list (),
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3739 pow (2.0, -1074e0), 0e0, "eps");
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3740 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3741 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3742 int expon;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3743 frexp (val, &expon);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	3744 val = std::pow (static_cast <double> (2.0),
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3745 static_cast <double> (expon - 53));
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	3746 retval = fill_matrix (octave_value_list (), val,
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3747 FLT_EPSILON, "eps");
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3748 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3749 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3750 }
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3751 }
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3752 else
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3753 retval = fill_matrix (args, DBL_EPSILON, FLT_EPSILON, "eps");
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3754
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3755 return retval;
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3756 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3757
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3758 /*
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3759
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3760 %!assert(eps(1/2),2^(-53))
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3761 %!assert(eps(1),2^(-52))
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3762 %!assert(eps(2),2^(-51))
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3763 %!assert(eps(realmax),2^971)
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3764 %!assert(eps(0),2^(-1074))
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3765 %!assert(eps(realmin/2),2^(-1074))
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3766 %!assert(eps(realmin/16),2^(-1074))
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3767 %!assert(eps(Inf),NaN)
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3768 %!assert(eps(NaN),NaN)
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3769 %!assert(eps(single(1/2)),single(2^(-24)))
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3770 %!assert(eps(single(1)),single(2^(-23)))
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3771 %!assert(eps(single(2)),single(2^(-22)))
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3772 %!assert(eps(realmax('single')),single(2^104))
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3773 %!assert(eps(single(0)),single(2^(-149)))
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3774 %!assert(eps(realmin('single')/2),single(2^(-149)))
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3775 %!assert(eps(realmin('single')/16),single(2^(-149)))
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3776 %!assert(eps(single(Inf)),single(NaN))
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3777 %!assert(eps(single(NaN)),single(NaN))
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3778
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3779 */
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3780
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3781
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3782 DEFUN (pi, args, ,
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3783 "-- texinfo --\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3784 @deftypefn {Built-in Function} {} pi\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3785 @deftypefnx {Built-in Function} {} pi (@var{n})\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3786 @deftypefnx {Built-in Function} {} pi (@var{n}, @var{m})\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3787 @deftypefnx {Built-in Function} {} pi (@var{n}, @var{m}, @var{k}, @dots{})\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3788 @deftypefnx {Built-in Function} {} pi (@dots{}, @var{class})\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3789 Return a scalar, matrix, or N-dimensional array whose elements are all equal\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3790 to the ratio of the circumference of a circle to its\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3791 @tex\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3792 diameter($\\pi$).\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3793 @end tex\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3794 @ifnottex\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3795 diameter.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3796 @end ifnottex\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3797 Internally, @code{pi} is computed as @samp{4.0 * atan (1.0)}.\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3798 \n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3799 When called with no arguments, return a scalar with the value of\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3800 @tex\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3801 $\\pi$.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3802 @end tex\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3803 @ifnottex\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3804 pi.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3805 @end ifnottex\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3806 When called with a single argument, return a square matrix with the dimension\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3807 specified. When called with more than one scalar argument the first two\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3808 arguments are taken as the number of rows and columns and any further\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3809 arguments specify additional matrix dimensions.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3810 The optional argument @var{class} specifies the return type and may be\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3811 either \"double\" or \"single\".\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3812 @end deftypefn")
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3813 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3814 #if defined (M_PI)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3815 double pi_val = M_PI;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3816 #else
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3817 double pi_val = 4.0 * atan (1.0);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3818 #endif
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3819
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3820 return fill_matrix (args, pi_val, "pi");
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3821 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3822
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3823 DEFUN (realmax, args, ,
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3824 "-- texinfo --\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3825 @deftypefn {Built-in Function} {} realmax\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3826 @deftypefnx {Built-in Function} {} realmax (@var{n})\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3827 @deftypefnx {Built-in Function} {} realmax (@var{n}, @var{m})\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3828 @deftypefnx {Built-in Function} {} realmax (@var{n}, @var{m}, @var{k}, @dots{})\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3829 @deftypefnx {Built-in Function} {} realmax (@dots{}, @var{class})\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3830 Return a scalar, matrix or N-dimensional array whose elements are all equal\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3831 to the largest floating point number that is representable. The actual\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3832 value is system dependent. On machines that support IEEE\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3833 floating point arithmetic, @code{realmax} is approximately\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3834 @tex\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3835 $1.7977\\times10^{308}$ for double precision and $3.4028\\times10^{38}$\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3836 @end tex\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 8487 diff changeset	3837 @ifnottex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3838 1.7977e+308 for double precision and 3.4028e+38\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 8487 diff changeset	3839 @end ifnottex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3840 for single precision.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3841 \n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3842 When called with no arguments, return a scalar with the value\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3843 @code{realmax(\"double\")}.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3844 When called with a single argument, return a square matrix with the dimension\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3845 specified. When called with more than one scalar argument the first two\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3846 arguments are taken as the number of rows and columns and any further\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3847 arguments specify additional matrix dimensions.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3848 The optional argument @var{class} specifies the return type and may be\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3849 either \"double\" or \"single\".\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3850 @seealso{realmin, intmax, bitmax}\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3851 @end deftypefn")
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3852 {
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3853 return fill_matrix (args, DBL_MAX, FLT_MAX, "realmax");
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3854 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3855
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3856 DEFUN (realmin, args, ,
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3857 "-- texinfo --\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3858 @deftypefn {Built-in Function} {} realmin\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3859 @deftypefnx {Built-in Function} {} realmin (@var{n})\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3860 @deftypefnx {Built-in Function} {} realmin (@var{n}, @var{m})\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3861 @deftypefnx {Built-in Function} {} realmin (@var{n}, @var{m}, @var{k}, @dots{})\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3862 @deftypefnx {Built-in Function} {} realmin (@dots{}, @var{class})\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3863 Return a scalar, matrix or N-dimensional array whose elements are all equal\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3864 to the smallest normalized floating point number that is representable.\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3865 The actual value is system dependent. On machines that support\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3866 IEEE floating point arithmetic, @code{realmin} is approximately\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3867 @tex\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3868 $2.2251\\times10^{-308}$ for double precision and $1.1755\\times10^{-38}$\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3869 @end tex\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 8487 diff changeset	3870 @ifnottex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3871 2.2251e-308 for double precision and 1.1755e-38\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 8487 diff changeset	3872 @end ifnottex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3873 for single precision.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3874 \n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3875 When called with no arguments, return a scalar with the value\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3876 @code{realmin(\"double\")}.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3877 When called with a single argument, return a square matrix with the dimension\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3878 specified. When called with more than one scalar argument the first two\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3879 arguments are taken as the number of rows and columns and any further\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3880 arguments specify additional matrix dimensions.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3881 The optional argument @var{class} specifies the return type and may be\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3882 either \"double\" or \"single\".\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3883 @seealso{realmax, intmin}\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3884 @end deftypefn")
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3885 {
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	3886 return fill_matrix (args, DBL_MIN, FLT_MIN, "realmin");
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3887 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3888
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3889 DEFUN (I, args, ,
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3890 "-- texinfo --\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3891 @deftypefn {Built-in Function} {} I\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3892 @deftypefnx {Built-in Function} {} I (@var{n})\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3893 @deftypefnx {Built-in Function} {} I (@var{n}, @var{m})\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3894 @deftypefnx {Built-in Function} {} I (@var{n}, @var{m}, @var{k}, @dots{})\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3895 @deftypefnx {Built-in Function} {} I (@dots{}, @var{class})\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3896 Return a scalar, matrix, or N-dimensional array whose elements are all equal\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3897 to the pure imaginary unit, defined as\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3898 @tex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3899 $\\sqrt{-1}$.\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3900 @end tex\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 8487 diff changeset	3901 @ifnottex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3902 @code{sqrt (-1)}.\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 8487 diff changeset	3903 @end ifnottex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3904 I, and its equivalents i, J, and j, are functions so any of the names may\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3905 be reused for other purposes (such as i for a counter variable).\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3906 \n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3907 When called with no arguments, return a scalar with the value @math{i}. When\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3908 called with a single argument, return a square matrix with the dimension\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3909 specified. When called with more than one scalar argument the first two\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3910 arguments are taken as the number of rows and columns and any further\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3911 arguments specify additional matrix dimensions.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3912 The optional argument @var{class} specifies the return type and may be\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	3913 either \"double\" or \"single\".\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3914 @end deftypefn")
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3915 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3916 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	3917 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3918
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3919 DEFALIAS (i, I);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3920 DEFALIAS (J, I);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3921 DEFALIAS (j, I);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3922
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3923 DEFUN (NA, args, ,
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3924 "-- texinfo --\n\
9308 f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	3925 @deftypefn {Built-in Function} {} NA\n\
f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	3926 @deftypefnx {Built-in Function} {} NA (@var{n})\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3927 @deftypefnx {Built-in Function} {} NA (@var{n}, @var{m})\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3928 @deftypefnx {Built-in Function} {} NA (@var{n}, @var{m}, @var{k}, @dots{})\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3929 @deftypefnx {Built-in Function} {} NA (@dots{}, @var{class})\n\
9308 f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	3930 Return a scalar, matrix, or N-dimensional array whose elements are all equal\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3931 to the special constant used to designate missing values.\n\
9308 f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	3932 \n\
f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	3933 Note that NA always compares not equal to NA (NA != NA).\n\
f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	3934 To find NA values, use the @code{isna} function.\n\
f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	3935 \n\
f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	3936 When called with no arguments, return a scalar with the value @samp{NA}.\n\
f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	3937 When called with a single argument, return a square matrix with the dimension\n\
f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	3938 specified. When called with more than one scalar argument the first two\n\
f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	3939 arguments are taken as the number of rows and columns and any further\n\
f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	3940 arguments specify additional matrix dimensions.\n\
f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	3941 The optional argument @var{class} specifies the return type and may be\n\
f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	3942 either \"double\" or \"single\".\n\
f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	3943 @seealso{isna}\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3944 @end deftypefn")
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3945 {
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	3946 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	3947 lo_ieee_float_na_value (), "NA");
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3948 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3949
7991 139f47cf17ab Change NA value to support single to double precision conversion David Bateman <dbateman@free.fr> parents: 7919 diff changeset	3950 /*
139f47cf17ab Change NA value to support single to double precision conversion David Bateman <dbateman@free.fr> parents: 7919 diff changeset	3951
139f47cf17ab Change NA value to support single to double precision conversion David Bateman <dbateman@free.fr> parents: 7919 diff changeset	3952 %!assert(single(NA('double')),NA('single'))
139f47cf17ab Change NA value to support single to double precision conversion David Bateman <dbateman@free.fr> parents: 7919 diff changeset	3953 %!assert(double(NA('single')),NA('double'))
139f47cf17ab Change NA value to support single to double precision conversion David Bateman <dbateman@free.fr> parents: 7919 diff changeset	3954
139f47cf17ab Change NA value to support single to double precision conversion David Bateman <dbateman@free.fr> parents: 7919 diff changeset	3955 */
139f47cf17ab Change NA value to support single to double precision conversion David Bateman <dbateman@free.fr> parents: 7919 diff changeset	3956
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3957 DEFUN (false, args, ,
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3958 "-- texinfo --\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	3959 @deftypefn {Built-in Function} {} false (@var{x})\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3960 @deftypefnx {Built-in Function} {} false (@var{n}, @var{m})\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3961 @deftypefnx {Built-in Function} {} false (@var{n}, @var{m}, @var{k}, @dots{})\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3962 Return a matrix or N-dimensional array whose elements are all logical 0.\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	3963 If invoked with a single scalar integer argument, return a square\n\
a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	3964 matrix of the specified size. If invoked with two or more scalar\n\
a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	3965 integer arguments, or a vector of integer values, return an array with\n\
a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	3966 given dimensions.\n\
a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	3967 @seealso{true}\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3968 @end deftypefn")
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3969 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3970 return fill_matrix (args, false, "false");
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3971 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3972
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3973 DEFUN (true, args, ,
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3974 "-- texinfo --\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	3975 @deftypefn {Built-in Function} {} true (@var{x})\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3976 @deftypefnx {Built-in Function} {} true (@var{n}, @var{m})\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3977 @deftypefnx {Built-in Function} {} true (@var{n}, @var{m}, @var{k}, @dots{})\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3978 Return a matrix or N-dimensional array whose elements are all logical 1.\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	3979 If invoked with a single scalar integer argument, return a square\n\
a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	3980 matrix of the specified size. If invoked with two or more scalar\n\
a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	3981 integer arguments, or a vector of integer values, return an array with\n\
a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	3982 given dimensions.\n\
a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	3983 @seealso{false}\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3984 @end deftypefn")
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3985 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	3986 return fill_matrix (args, true, "true");
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	3987 }
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3988
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3989 template <class MT>
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3990 octave_value
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3991 identity_matrix (int nr, int nc)
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3992 {
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3993 octave_value retval;
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3994
9685 e793865ede63 implement builtin_type Jaroslav Hajek <highegg@gmail.com> parents: 9658 diff changeset	3995 typename MT::element_type one (1);
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3996
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3997 if (nr == 1 && nc == 1)
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3998 retval = one;
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	3999 else
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4000 {
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4001 dim_vector dims (nr, nc);
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4002
9685 e793865ede63 implement builtin_type Jaroslav Hajek <highegg@gmail.com> parents: 9658 diff changeset	4003 typename MT::element_type zero (0);
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4004
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4005 MT m (dims, zero);
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4006
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4007 if (nr > 0 && nc > 0)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4008 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4009 int n = std::min (nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4010
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4011 for (int i = 0; i < n; i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4012 m(i,i) = one;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4013 }
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4014
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4015 retval = m;
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4016 }
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4017
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4018 return retval;
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4019 }
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4020
5058 11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	4021 #define INSTANTIATE_EYE(T) \
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	4022 template octave_value identity_matrix<T> (int, int)
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	4023
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	4024 INSTANTIATE_EYE (int8NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	4025 INSTANTIATE_EYE (uint8NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	4026 INSTANTIATE_EYE (int16NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	4027 INSTANTIATE_EYE (uint16NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	4028 INSTANTIATE_EYE (int32NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	4029 INSTANTIATE_EYE (uint32NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	4030 INSTANTIATE_EYE (int64NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	4031 INSTANTIATE_EYE (uint64NDArray);
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	4032 INSTANTIATE_EYE (FloatNDArray);
5058 11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	4033 INSTANTIATE_EYE (NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	4034 INSTANTIATE_EYE (boolNDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	4035
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4036 static octave_value
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	4037 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	4038 {
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4039 octave_value retval;
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4040
5775 ace8d8d26933 [project @ 2006-04-24 19:13:06 by jwe] jwe parents: 5747 diff changeset	4041 // FIXME -- perhaps this should be made extensible by using
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4042 // the class name to lookup a function to call to create the new
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4043 // value.
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4044
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4045 if (! error_state)
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4046 {
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4047 switch (dt)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4048 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4049 case oct_data_conv::dt_int8:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4050 retval = identity_matrix<int8NDArray> (nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4051 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4052
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4053 case oct_data_conv::dt_uint8:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4054 retval = identity_matrix<uint8NDArray> (nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4055 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4056
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4057 case oct_data_conv::dt_int16:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4058 retval = identity_matrix<int16NDArray> (nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4059 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4060
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4061 case oct_data_conv::dt_uint16:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4062 retval = identity_matrix<uint16NDArray> (nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4063 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4064
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4065 case oct_data_conv::dt_int32:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4066 retval = identity_matrix<int32NDArray> (nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4067 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4068
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4069 case oct_data_conv::dt_uint32:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4070 retval = identity_matrix<uint32NDArray> (nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4071 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4072
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4073 case oct_data_conv::dt_int64:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4074 retval = identity_matrix<int64NDArray> (nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4075 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4076
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4077 case oct_data_conv::dt_uint64:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4078 retval = identity_matrix<uint64NDArray> (nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4079 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4080
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4081 case oct_data_conv::dt_single:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4082 retval = FloatDiagMatrix (nr, nc, 1.0f);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4083 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4084
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4085 case oct_data_conv::dt_double:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4086 retval = DiagMatrix (nr, nc, 1.0);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4087 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4088
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4089 case oct_data_conv::dt_logical:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4090 retval = identity_matrix<boolNDArray> (nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4091 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4092
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4093 default:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4094 error ("eye: invalid class name");
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4095 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4096 }
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4097 }
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4098
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4099 return retval;
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4100 }
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4101
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4102 #undef INT_EYE_MATRIX
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4103
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	4104 DEFUN (eye, args, ,
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4105 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	4106 @deftypefn {Built-in Function} {} eye (@var{x})\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4107 @deftypefnx {Built-in Function} {} eye (@var{n}, @var{m})\n\
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	4108 @deftypefnx {Built-in Function} {} eye (@dots{}, @var{class})\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4109 Return an identity matrix. If invoked with a single scalar argument,\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4110 @code{eye} returns a square matrix with the dimension specified. If you\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4111 supply two scalar arguments, @code{eye} takes them to be the number of\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4112 rows and columns. If given a vector with two elements, @code{eye} uses\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4113 the values of the elements as the number of rows and columns,\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	4114 respectively. For example:\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4115 \n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4116 @example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4117 @group\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4118 eye (3)\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4119 @result{} 1 0 0\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4120 0 1 0\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4121 0 0 1\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4122 @end group\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4123 @end example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4124 \n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4125 The following expressions all produce the same result:\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4126 \n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4127 @example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4128 @group\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4129 eye (2)\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4130 @equiv{}\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4131 eye (2, 2)\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4132 @equiv{}\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4133 eye (size ([1, 2; 3, 4])\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4134 @end group\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4135 @end example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4136 \n\
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4137 The optional argument @var{class}, allows @code{eye} to return an array of\n\
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4138 the specified type, like\n\
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4139 \n\
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4140 @example\n\
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4141 val = zeros (n,m, \"uint8\")\n\
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4142 @end example\n\
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4143 \n\
6556 8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6518 diff changeset	4144 Calling @code{eye} with no arguments is equivalent to calling it\n\
8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6518 diff changeset	4145 with an argument of 1. This odd definition is for compatibility\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	4146 with @sc{matlab}.\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4147 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4148 {
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	4149 octave_value retval;
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4150
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	4151 int nargin = args.length ();
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4152
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	4153 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	4154
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4155 // Check for type information.
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4156
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4157 if (nargin > 0 && args(nargin-1).is_string ())
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4158 {
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	4159 std::string nm = args(nargin-1).string_value ();
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4160 nargin--;
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	4161
7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	4162 dt = oct_data_conv::string_to_data_type (nm);
7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	4163
7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	4164 if (error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4165 return retval;
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4166 }
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4167
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4168 switch (nargin)
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4169 {
712 36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	4170 case 0:
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	4171 retval = identity_matrix (1, 1, dt);
712 36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	4172 break;
777 a2f9d3fd720c [project @ 1994-10-07 14:01:53 by jwe] jwe parents: 767 diff changeset	4173
610 14b2a186a5c0 [project @ 1994-08-14 00:55:49 by jwe] jwe parents: 597 diff changeset	4174 case 1:
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	4175 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4176 octave_idx_type nr, nc;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4177 get_dimensions (args(0), "eye", nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4178
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4179 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4180 retval = identity_matrix (nr, nc, dt);
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	4181 }
610 14b2a186a5c0 [project @ 1994-08-14 00:55:49 by jwe] jwe parents: 597 diff changeset	4182 break;
777 a2f9d3fd720c [project @ 1994-10-07 14:01:53 by jwe] jwe parents: 767 diff changeset	4183
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4184 case 2:
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	4185 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4186 octave_idx_type nr, nc;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4187 get_dimensions (args(0), args(1), "eye", nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4188
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4189 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4190 retval = identity_matrix (nr, nc, dt);
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	4191 }
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4192 break;
777 a2f9d3fd720c [project @ 1994-10-07 14:01:53 by jwe] jwe parents: 767 diff changeset	4193
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4194 default:
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	4195 print_usage ();
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4196 break;
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4197 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4198
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4199 return retval;
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4200 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4201
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4202
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4203 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4204
8459 d17874a6f161 improve indexing of diagonal & permutation matrices Jaroslav Hajek <highegg@gmail.com> parents: 8458 diff changeset	4205 %!assert (full (eye(3)), [1, 0, 0; 0, 1, 0; 0, 0, 1]);
d17874a6f161 improve indexing of diagonal & permutation matrices Jaroslav Hajek <highegg@gmail.com> parents: 8458 diff changeset	4206 %!assert (full (eye(2, 3)), [1, 0, 0; 0, 1, 0]);
d17874a6f161 improve indexing of diagonal & permutation matrices Jaroslav Hajek <highegg@gmail.com> parents: 8458 diff changeset	4207
d17874a6f161 improve indexing of diagonal & permutation matrices Jaroslav Hajek <highegg@gmail.com> parents: 8458 diff changeset	4208 %!assert (full (eye(3,'single')), single([1, 0, 0; 0, 1, 0; 0, 0, 1]));
d17874a6f161 improve indexing of diagonal & permutation matrices Jaroslav Hajek <highegg@gmail.com> parents: 8458 diff changeset	4209 %!assert (full (eye(2, 3,'single')), single([1, 0, 0; 0, 1, 0]));
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4210
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4211 %!assert (eye(3,'int8'), int8([1, 0, 0; 0, 1, 0; 0, 0, 1]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4212 %!assert (eye(2, 3,'int8'), int8([1, 0, 0; 0, 1, 0]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4213
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4214 %!error <Invalid call to eye.*> eye (1, 2, 3);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4215
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4216 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4217
9658 3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4218 template <class MT>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4219 static octave_value
9658 3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4220 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	4221 octave_idx_type n)
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4222 {
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4223 typedef typename MT::column_vector_type CVT;
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4224 typedef typename MT::element_type T;
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4225
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4226 octave_value retval;
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4227
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4228 if (base.is_scalar_type ())
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4229 {
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4230 T bs = octave_value_extract<T> (base);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4231 if (limit.is_scalar_type ())
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4232 {
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4233 T ls = octave_value_extract<T> (limit);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4234 retval = linspace (bs, ls, n);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4235 }
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4236 else
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4237 {
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4238 CVT lv = octave_value_extract<CVT> (limit);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4239 CVT bv (lv.length (), bs);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4240 retval = linspace (bv, lv, n);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4241 }
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4242 }
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4243 else
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4244 {
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4245 CVT bv = octave_value_extract<CVT> (base);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4246 if (limit.is_scalar_type ())
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4247 {
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4248 T ls = octave_value_extract<T> (limit);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4249 CVT lv (bv.length (), ls);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4250 retval = linspace (bv, lv, n);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4251 }
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4252 else
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4253 {
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4254 CVT lv = octave_value_extract<CVT> (limit);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4255 retval = linspace (bv, lv, n);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4256 }
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4257 }
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4258
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4259 return retval;
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4260 }
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4261
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	4262 DEFUN (linspace, args, ,
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4263 "-- texinfo --\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4264 @deftypefn {Built-in Function} {} linspace (@var{base}, @var{limit}, @var{n})\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4265 Return a row vector with @var{n} linearly spaced elements between\n\
6630 0fcc8d65b571 [project @ 2007-05-16 15:32:09 by jwe] jwe parents: 6561 diff changeset	4266 @var{base} and @var{limit}. If the number of elements is greater than one,\n\
0fcc8d65b571 [project @ 2007-05-16 15:32:09 by jwe] jwe parents: 6561 diff changeset	4267 then the @var{base} and @var{limit} are always included in\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4268 the range. If @var{base} is greater than @var{limit}, the elements are\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4269 stored in decreasing order. If the number of points is not specified, a\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4270 value of 100 is used.\n\
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	4271 \n\
9658 3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4272 The @code{linspace} function always returns a row vector if both\n\
9758 09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format Rik <rdrider0-list@yahoo.com> parents: 9736 diff changeset	4273 @var{base} and @var{limit} are scalars. If one of them or both are column\n\
9658 3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4274 vectors, @code{linspace} returns a matrix.\n\
6630 0fcc8d65b571 [project @ 2007-05-16 15:32:09 by jwe] jwe parents: 6561 diff changeset	4275 \n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	4276 For compatibility with @sc{matlab}, return the second argument if\n\
6630 0fcc8d65b571 [project @ 2007-05-16 15:32:09 by jwe] jwe parents: 6561 diff changeset	4277 fewer than two values are requested.\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4278 @end deftypefn")
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	4279 {
3418 ca92c9d3f882 [project @ 2000-01-12 03:07:47 by jwe] jwe parents: 3373 diff changeset	4280 octave_value retval;
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	4281
3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	4282 int nargin = args.length ();
3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	4283
6133 e0065af38cf4 [project @ 2006-11-02 03:33:50 by jwe] jwe parents: 5991 diff changeset	4284 octave_idx_type npoints = 100;
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	4285
1940 1b193e313c56 [project @ 1996-02-13 16:28:47 by jwe] jwe parents: 1884 diff changeset	4286 if (nargin != 2 && nargin != 3)
1b193e313c56 [project @ 1996-02-13 16:28:47 by jwe] jwe parents: 1884 diff changeset	4287 {
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	4288 print_usage ();
1940 1b193e313c56 [project @ 1996-02-13 16:28:47 by jwe] jwe parents: 1884 diff changeset	4289 return retval;
1b193e313c56 [project @ 1996-02-13 16:28:47 by jwe] jwe parents: 1884 diff changeset	4290 }
1b193e313c56 [project @ 1996-02-13 16:28:47 by jwe] jwe parents: 1884 diff changeset	4291
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	4292 if (nargin == 3)
6133 e0065af38cf4 [project @ 2006-11-02 03:33:50 by jwe] jwe parents: 5991 diff changeset	4293 npoints = args(2).idx_type_value ();
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	4294
3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	4295 if (! error_state)
3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	4296 {
3322 8c6b4de3bdc8 [project @ 1999-10-26 21:33:27 by jwe] jwe parents: 3321 diff changeset	4297 octave_value arg_1 = args(0);
8c6b4de3bdc8 [project @ 1999-10-26 21:33:27 by jwe] jwe parents: 3321 diff changeset	4298 octave_value arg_2 = args(1);
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	4299
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	4300 if (arg_1.is_single_type () \|\| arg_2.is_single_type ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4301 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4302 if (arg_1.is_complex_type () \|\| arg_2.is_complex_type ())
9658 3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4303 retval = do_linspace<FloatComplexMatrix> (arg_1, arg_2, npoints);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4304 else
9658 3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4305 retval = do_linspace<FloatMatrix> (arg_1, arg_2, npoints);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4306
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4307 }
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	4308 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4309 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4310 if (arg_1.is_complex_type () \|\| arg_2.is_complex_type ())
9658 3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4311 retval = do_linspace<ComplexMatrix> (arg_1, arg_2, npoints);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4312 else
9658 3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	4313 retval = do_linspace<Matrix> (arg_1, arg_2, npoints);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4314 }
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	4315 }
4732 b484cdca27be [project @ 2004-02-04 04:32:48 by jwe] jwe parents: 4685 diff changeset	4316 else
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	4317 error ("linspace: N must be an integer");
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	4318
3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	4319 return retval;
3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	4320 }
3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	4321
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4322
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4323 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4324
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4325 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4326 %! 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	4327 %! 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	4328 %! x3 = 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	4329 %! assert((size (x1) == [1, 100] && x1(1) == 1 && x1(100) == 2
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4330 %! && size (x2) == [1, 10] && x2(1) == 1 && x2(10) == 2
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4331 %! && size (x3) == [1, 10] && x3(1) == 1 && x3(10) == -2));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4332
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4333
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4334 % assert(linspace ([1, 2; 3, 4], 5, 6), linspace (1, 5, 6));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4335
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4336 %!error <Invalid call to linspace.*> linspace ();
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4337 %!error <Invalid call to linspace.*> linspace (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	4338
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4339 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4340 %! fail("linspace ([1, 2; 3, 4], 5, 6)","warning");
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4341
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4342 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4343
5775 ace8d8d26933 [project @ 2006-04-24 19:13:06 by jwe] jwe parents: 5747 diff changeset	4344 // FIXME -- should accept dimensions as separate args for N-d
5734 a7d2c47371d2 [project @ 2006-04-04 18:29:13 by jwe] jwe parents: 5731 diff changeset	4345 // arrays as well as 1-d and 2-d arrays.
a7d2c47371d2 [project @ 2006-04-04 18:29:13 by jwe] jwe parents: 5731 diff changeset	4346
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	4347 DEFUN (resize, args, ,
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	4348 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	4349 @deftypefn {Built-in Function} {} resize (@var{x}, @var{m})\n\
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	4350 @deftypefnx {Built-in Function} {} resize (@var{x}, @var{m}, @var{n})\n\
8799 f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4351 @deftypefnx {Built-in Function} {} resize (@var{x}, @var{m}, @var{n}, @dots{})\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4352 Resize @var{x} cutting off elements as necessary.\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4353 \n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4354 In the result, element with certain indices is equal to the corresponding\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4355 element of @var{x} if the indices are within the bounds of @var{x};\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4356 otherwise, the element is set to zero.\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4357 \n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4358 In other words, the statement\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4359 \n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4360 @example\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4361 y = resize (x, dv);\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4362 @end example\n\
6174 d3c599afc455 [project @ 2006-11-16 17:52:02 by jwe] jwe parents: 6156 diff changeset	4363 \n\
8799 f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4364 @noindent\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4365 is equivalent to the following code:\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4366 \n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4367 @example\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	4368 @group\n\
8799 f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4369 y = zeros (dv, class (x));\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4370 sz = min (dv, size (x));\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4371 for i = 1:length (sz), idx@{i@} = 1:sz(i); endfor\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4372 y(idx@{:@}) = x(idx@{:@});\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	4373 @end group\n\
8799 f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4374 @end example\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4375 \n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4376 @noindent\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4377 but is performed more efficiently.\n\
6174 d3c599afc455 [project @ 2006-11-16 17:52:02 by jwe] jwe parents: 6156 diff changeset	4378 \n\
d3c599afc455 [project @ 2006-11-16 17:52:02 by jwe] jwe parents: 6156 diff changeset	4379 If only @var{m} is supplied and it is a scalar, the dimension of the\n\
d3c599afc455 [project @ 2006-11-16 17:52:02 by jwe] jwe parents: 6156 diff changeset	4380 result is @var{m}-by-@var{m}. If @var{m} is a vector, then the\n\
d3c599afc455 [project @ 2006-11-16 17:52:02 by jwe] jwe parents: 6156 diff changeset	4381 dimensions of the result are given by the elements of @var{m}.\n\
d3c599afc455 [project @ 2006-11-16 17:52:02 by jwe] jwe parents: 6156 diff changeset	4382 If both @var{m} and @var{n} are scalars, then the dimensions of\n\
d3c599afc455 [project @ 2006-11-16 17:52:02 by jwe] jwe parents: 6156 diff changeset	4383 the result are @var{m}-by-@var{n}.\n\
8799 f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4384 \n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4385 An object can be resized to more dimensions than it has;\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4386 in such case the missing dimensions are assumed to be 1.\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4387 Resizing an object to fewer dimensions is not possible.\n\
8433 3292bd1bbaa4 Cross reference between postpad and resize Francesco PotortÃ¬ <pot@gnu.org> parents: 8429 diff changeset	4388 @seealso{reshape, postpad}\n\
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	4389 @end deftypefn")
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	4390 {
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	4391 octave_value retval;
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	4392 int nargin = args.length ();
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	4393
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	4394 if (nargin == 2)
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	4395 {
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	4396 Array<double> vec = args(1).vector_value ();
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	4397 int ndim = vec.length ();
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	4398 if (ndim == 1)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4399 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4400 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	4401 retval = args(0);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4402 retval = retval.resize (dim_vector (m, m), true);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4403 }
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	4404 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4405 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4406 dim_vector dv;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4407 dv.resize (ndim);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4408 for (int i = 0; i < ndim; i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4409 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	4410 retval = args(0);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4411 retval = retval.resize (dv, true);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4412 }
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	4413 }
8799 f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4414 else if (nargin > 2)
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	4415 {
8799 f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4416 dim_vector dv;
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4417 dv.resize (nargin - 1);
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4418 for (octave_idx_type i = 1; i < nargin; i++)
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4419 dv(i-1) = static_cast<octave_idx_type> (args(i).scalar_value ());
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	4420 if (!error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4421 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4422 retval = args(0);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4423 retval = retval.resize (dv, true);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4424 }
8799 f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	4425
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	4426 }
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	4427 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	4428 print_usage ();
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	4429 return retval;
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	4430 }
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	4431
5775 ace8d8d26933 [project @ 2006-04-24 19:13:06 by jwe] jwe parents: 5747 diff changeset	4432 // FIXME -- should use octave_idx_type for dimensions.
5734 a7d2c47371d2 [project @ 2006-04-04 18:29:13 by jwe] jwe parents: 5731 diff changeset	4433
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4434 DEFUN (reshape, args, ,
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4435 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	4436 @deftypefn {Built-in Function} {} reshape (@var{a}, @var{m}, @var{n}, @dots{})\n\
9041 853f96e8008f Cleanup documentation file matrix.texi Rik <rdrider0-list@yahoo.com> parents: 8972 diff changeset	4437 @deftypefnx {Built-in Function} {} reshape (@var{a}, @var{size})\n\
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4438 Return a matrix with the given dimensions whose elements are taken\n\
6671 9042b00fc45e [project @ 2007-05-30 06:33:29 by jwe] jwe parents: 6630 diff changeset	4439 from the matrix @var{a}. The elements of the matrix are accessed in\n\
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4440 column-major order (like Fortran arrays are stored).\n\
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4441 \n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	4442 For example:\n\
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4443 \n\
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4444 @example\n\
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4445 @group\n\
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4446 reshape ([1, 2, 3, 4], 2, 2)\n\
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4447 @result{} 1 3\n\
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4448 2 4\n\
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4449 @end group\n\
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4450 @end example\n\
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4451 \n\
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4452 @noindent\n\
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4453 Note that the total number of elements in the original\n\
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4454 matrix must match the total number of elements in the new matrix.\n\
5013 1eb9ce5c0152 [project @ 2004-09-21 22:18:07 by jwe] jwe parents: 4986 diff changeset	4455 \n\
1eb9ce5c0152 [project @ 2004-09-21 22:18:07 by jwe] jwe parents: 4986 diff changeset	4456 A single dimension of the return matrix can be unknown and is flagged\n\
1eb9ce5c0152 [project @ 2004-09-21 22:18:07 by jwe] jwe parents: 4986 diff changeset	4457 by an empty argument.\n\
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4458 @end deftypefn")
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4459 {
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4460 octave_value retval;
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4461
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4462 int nargin = args.length ();
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4463
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4464 dim_vector new_dims;
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4465
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4466 if (nargin == 2)
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4467 {
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4468 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	4469
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4470 new_dims = dim_vector::alloc (new_size.length ());
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4471
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4472 for (octave_idx_type i = 0; i < new_size.length (); i++)
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4473 {
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4474 if (new_size(i) < 0)
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4475 {
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	4476 error ("reshape: SIZE must be non-negative");
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4477 break;
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4478 }
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4479 else
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4480 new_dims(i) = new_size(i);
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4481 }
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4482 }
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4483 else if (nargin > 2)
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4484 {
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4485 new_dims = dim_vector::alloc (nargin-1);
5013 1eb9ce5c0152 [project @ 2004-09-21 22:18:07 by jwe] jwe parents: 4986 diff changeset	4486 int empty_dim = -1;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4487
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4488 for (int i = 1; i < nargin; i++)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4489 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4490 if (args(i).is_empty ())
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4491 {
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4492 if (empty_dim > 0)
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4493 {
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4494 error ("reshape: only a single dimension can be unknown");
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4495 break;
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4496 }
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4497 else
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4498 {
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4499 empty_dim = i;
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4500 new_dims(i-1) = 1;
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4501 }
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4502 }
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4503 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4504 {
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4505 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	4506
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4507 if (error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4508 break;
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4509 else if (new_dims(i-1) < 0)
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4510 {
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	4511 error ("reshape: SIZE must be non-negative");
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4512 break;
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4513 }
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4514 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4515 }
5013 1eb9ce5c0152 [project @ 2004-09-21 22:18:07 by jwe] jwe parents: 4986 diff changeset	4516
1eb9ce5c0152 [project @ 2004-09-21 22:18:07 by jwe] jwe parents: 4986 diff changeset	4517 if (! error_state && (empty_dim > 0))
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4518 {
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4519 octave_idx_type nel = new_dims.numel ();
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4520
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4521 if (nel == 0)
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4522 new_dims(empty_dim-1) = 0;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4523 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4524 {
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4525 octave_idx_type a_nel = args(0).numel ();
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4526 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	4527
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4528 if (a_nel != size_empty_dim * nel)
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	4529 error ("reshape: SIZE is not divisible by the product of known dimensions (= %d)", nel);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4530 else
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	4531 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	4532 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4533 }
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4534 }
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4535 else
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4536 {
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	4537 print_usage ();
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4538 return retval;
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4539 }
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4540
10352 a3635bc1ea19 remove Array2 Jaroslav Hajek <highegg@gmail.com> parents: 10350 diff changeset	4541 if (! error_state)
a3635bc1ea19 remove Array2 Jaroslav Hajek <highegg@gmail.com> parents: 10350 diff changeset	4542 retval = args(0).reshape (new_dims);
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4543
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4544 return retval;
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4545 }
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	4546
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4547 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4548
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4549 %!assert(size (reshape (ones (4, 4), 2, 8)), [2, 8])
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4550 %!assert(size (reshape (ones (4, 4), 8, 2)), [8, 2])
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4551 %!assert(size (reshape (ones (15, 4), 1, 60)), [1, 60])
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4552 %!assert(size (reshape (ones (15, 4), 60, 1)), [60, 1])
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4553
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4554 %!assert(size (reshape (ones (4, 4, 'single'), 2, 8)), [2, 8])
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4555 %!assert(size (reshape (ones (4, 4, 'single'), 8, 2)), [8, 2])
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4556 %!assert(size (reshape (ones (15, 4, 'single'), 1, 60)), [1, 60])
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4557 %!assert(size (reshape (ones (15, 4, 'single'), 60, 1)), [60, 1])
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4558
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4559 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4560 %! s.a = 1;
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4561 %! fail("reshape (s, 2, 3)");
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4562
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4563 %!error <Invalid call to reshape.*> reshape ();
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4564 %!error reshape (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	4565
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4566 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4567
10694 d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4568 DEFUN (vec, args, ,
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4569 "-- texinfo --\n\
11402 a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4570 @deftypefn {Built-in Function} {} @var{v} = vec (@var{x})\n\
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4571 @deftypefnx {Built-in Function} {} @var{v} = vec (@var{x}, @var{dim})\n\
10694 d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4572 Return the vector obtained by stacking the columns of the matrix @var{x}\n\
11402 a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4573 one above the other. Without @var{dim} this is equivalent to\n\
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4574 @code{@var{x}(:)}. If @var{dim} is supplied, the dimensions of @var{v}\n\
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4575 are set to @var{dim} with all elements along the last dimension.\n\
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4576 This is equivalent to @code{shiftdim (@var{x}(:), 1-@var{dim})}.\n\
10694 d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4577 @end deftypefn")
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4578 {
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4579 octave_value retval;
11402 a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4580 int dim = 1;
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4581
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4582 int nargin = args.length ();
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4583
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4584 if (nargin < 1 \|\| nargin > 2)
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4585 print_usage () ;
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4586
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4587 if (! error_state && nargin == 2)
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4588 {
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4589 dim = args(1).idx_type_value ();
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4590
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4591 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	4592 error ("vec: DIM must be greater than zero");
11402 a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4593 }
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4594
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4595 if (! error_state)
10694 d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4596 {
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4597 octave_value colon (octave_value::magic_colon_t);
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4598 octave_value arg = args(0);
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4599 retval = arg.single_subsref ("(", colon);
11402 a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4600
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4601
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4602 if (! error_state && dim > 1)
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4603 {
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4604 dim_vector new_dims = dim_vector::alloc (dim);
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4605
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4606 for (int i = 0; i < dim-1; i++)
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4607 new_dims(i) = 1;
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4608
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4609 new_dims(dim-1) = retval.numel ();
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4610
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4611 retval = retval.reshape (new_dims);
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4612 }
10694 d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4613 }
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4614
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4615 return retval;
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4616 }
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4617
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4618 /*
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4619
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4620 %!assert(vec ([1, 2; 3, 4]), [1; 3; 2; 4])
11402 a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4621 %!assert(vec ([1, 3, 2, 4]), [1; 3; 2; 4]);
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4622 %!assert(vec ([1, 2, 3, 4], 2), [1, 2, 3, 4]);
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4623 %!assert(vec ([1, 2; 3, 4]), vec ([1, 2; 3, 4], 1));
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4624 %!assert(vec ([1, 2; 3, 4], 1), [1; 3; 2; 4]);
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4625 %!assert(vec ([1, 2; 3, 4], 2), [1, 3, 2, 4]);
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4626 %!assert(vec ([1, 3; 2, 4], 3), reshape ([1, 2, 3, 4], 1, 1, 4));
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4627 %!assert(vec ([1, 3; 2, 4], 3), shiftdim (vec ([1, 3; 2, 4]), -2));
10694 d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4628
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4629 %!error vec ();
11402 a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4630 %!error vec (1, 2, 3);
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	4631 %!error vec ([1, 2; 3, 4], 0);
10694 d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4632
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4633 */
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	4634
4532 01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	4635 DEFUN (squeeze, args, ,
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	4636 "-- texinfo --\n\
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	4637 @deftypefn {Built-in Function} {} squeeze (@var{x})\n\
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	4638 Remove singleton dimensions from @var{x} and return the result.\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	4639 Note that for compatibility with @sc{matlab}, all objects have\n\
7007 6304d9ea0a30 [project @ 2007-10-11 16:26:36 by jwe] jwe parents: 7001 diff changeset	4640 a minimum of two dimensions and row vectors are left unchanged.\n\
4532 01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	4641 @end deftypefn")
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	4642 {
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	4643 octave_value retval;
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	4644
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	4645 if (args.length () == 1)
4545 c16f153836a0 [project @ 2003-10-24 04:45:45 by jwe] jwe parents: 4532 diff changeset	4646 retval = args(0).squeeze ();
4532 01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	4647 else
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4648 print_usage ();
4532 01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	4649
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	4650 return retval;
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	4651 }
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	4652
8458 d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	4653 DEFUN (full, args, ,
d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	4654 "-- texinfo --\n\
d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	4655 @deftypefn {Loadable Function} {@var{FM} =} full (@var{SM})\n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	4656 returns a full storage matrix from a sparse, diagonal, permutation matrix\n\
a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	4657 or a range.\n\
8458 d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	4658 @seealso{sparse}\n\
d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	4659 @end deftypefn")
d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	4660 {
d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	4661 octave_value retval;
d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	4662
d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	4663 if (args.length () == 1)
d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	4664 retval = args(0).full_value ();
d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	4665 else
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4666 print_usage ();
8458 d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	4667
d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	4668 return retval;
d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	4669 }
d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	4670
6945 6bbf56a9718a [project @ 2007-10-02 20:47:22 by jwe] jwe parents: 6887 diff changeset	4671 // Compute various norms of the vector X.
6bbf56a9718a [project @ 2007-10-02 20:47:22 by jwe] jwe parents: 6887 diff changeset	4672
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4673 DEFUN (norm, args, ,
6508 184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	4674 "-- texinfo --\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	4675 @deftypefn {Built-in Function} {} norm (@var{a})\n\
a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	4676 @deftypefnx {Built-in Function} {} norm (@var{a}, @var{p})\n\
a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	4677 @deftypefnx {Built-in Function} {} norm (@var{a}, @var{p}, @var{opt})\n\
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4678 Compute the p-norm of the matrix @var{a}. If the second argument is\n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4679 missing, @code{p = 2} is assumed.\n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4680 \n\
8303 b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4681 If @var{a} is a matrix (or sparse matrix):\n\
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4682 \n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4683 @table @asis\n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4684 @item @var{p} = @code{1}\n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4685 1-norm, the largest column sum of the absolute values of @var{a}.\n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4686 \n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4687 @item @var{p} = @code{2}\n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4688 Largest singular value of @var{a}.\n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4689 \n\
7189 e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7145 diff changeset	4690 @item @var{p} = @code{Inf} or @code{\"inf\"}\n\
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4691 @cindex infinity norm\n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4692 Infinity norm, the largest row sum of the absolute values of @var{a}.\n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4693 \n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4694 @item @var{p} = @code{\"fro\"}\n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4695 @cindex Frobenius norm\n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4696 Frobenius norm of @var{a}, @code{sqrt (sum (diag (@var{a}' * @var{a})))}.\n\
8303 b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4697 \n\
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4698 @item other @var{p}, @code{@var{p} > 1}\n\
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4699 @cindex general p-norm \n\
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4700 maximum @code{norm (A*x, p)} such that @code{norm (x, p) == 1}\n\
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4701 @end table\n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4702 \n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4703 If @var{a} is a vector or a scalar:\n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4704 \n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4705 @table @asis\n\
7189 e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7145 diff changeset	4706 @item @var{p} = @code{Inf} or @code{\"inf\"}\n\
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4707 @code{max (abs (@var{a}))}.\n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4708 \n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4709 @item @var{p} = @code{-Inf}\n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4710 @code{min (abs (@var{a}))}.\n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4711 \n\
7189 e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7145 diff changeset	4712 @item @var{p} = @code{\"fro\"}\n\
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7145 diff changeset	4713 Frobenius norm of @var{a}, @code{sqrt (sumsq (abs (a)))}.\n\
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7145 diff changeset	4714 \n\
8303 b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4715 @item @var{p} = 0\n\
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4716 Hamming norm - the number of nonzero elements.\n\
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4717 \n\
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4718 @item other @var{p}, @code{@var{p} > 1}\n\
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4719 p-norm of @var{a}, @code{(sum (abs (@var{a}) .^ @var{p})) ^ (1/@var{p})}.\n\
8303 b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4720 \n\
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4721 @item other @var{p} @code{@var{p} < 1}\n\
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4722 the p-pseudonorm defined as above.\n\
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4723 @end table\n\
8303 b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4724 \n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	4725 If @var{opt} is the value @code{\"rows\"}, treat each row as a vector and\n\
a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	4726 compute its norm. The result is returned as a column vector.\n\
a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	4727 Similarly, if @var{opt} is @code{\"columns\"} or @code{\"cols\"} then compute\n\
a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	4728 the norms of each column and return a row vector.\n\
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4729 @seealso{cond, svd}\n\
6508 184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	4730 @end deftypefn")
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	4731 {
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4732 octave_value_list retval;
6508 184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	4733
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	4734 int nargin = args.length ();
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	4735
8303 b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4736 if (nargin >= 1 && nargin <= 3)
6508 184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	4737 {
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4738 octave_value x_arg = args(0);
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	4739
10185 455759a5fcbe fix norm and svd on empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 10182 diff changeset	4740 if (x_arg.ndims () == 2)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4741 {
8303 b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4742 enum { sfmatrix, sfcols, sfrows, sffrob, sfinf } strflag = sfmatrix;
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4743 if (nargin > 1 && args(nargin-1).is_string ())
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4744 {
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4745 std::string str = args(nargin-1).string_value ();
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4746 if (str == "cols" \|\| str == "columns")
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4747 strflag = sfcols;
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4748 else if (str == "rows")
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4749 strflag = sfrows;
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4750 else if (str == "fro")
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4751 strflag = sffrob;
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4752 else if (str == "inf")
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4753 strflag = sfinf;
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4754 else
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4755 error ("norm: unrecognized option: %s", str.c_str ());
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4756 // we've handled the last parameter, so act as if it was removed
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4757 nargin --;
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4758 }
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4759 else if (nargin > 1 && ! args(1).is_scalar_type ())
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4760 gripe_wrong_type_arg ("norm", args(1), true);
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4761
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4762 if (! error_state)
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4763 {
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4764 octave_value p_arg = (nargin > 1) ? args(1) : octave_value (2);
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4765 switch (strflag)
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4766 {
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4767 case sfmatrix:
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4768 retval(0) = xnorm (x_arg, p_arg);
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4769 break;
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4770 case sfcols:
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4771 retval(0) = xcolnorms (x_arg, p_arg);
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4772 break;
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4773 case sfrows:
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4774 retval(0) = xrownorms (x_arg, p_arg);
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4775 break;
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4776 case sffrob:
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4777 retval(0) = xfrobnorm (x_arg);
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4778 break;
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4779 case sfinf:
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4780 retval(0) = xnorm (x_arg, octave_Inf);
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4781 break;
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4782 }
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	4783 }
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4784 }
6508 184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	4785 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4786 error ("norm: only valid for 2-D objects");
6508 184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	4787 }
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	4788 else
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	4789 print_usage ();
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	4790
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	4791 return retval;
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	4792 }
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	4793
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4794 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4795 %!shared x
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4796 %! x = [1, -3, 4, 5, -7];
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4797 %!assert(norm(x,1), 20);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4798 %!assert(norm(x,2), 10);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4799 %!assert(norm(x,3), 8.24257059961711, -4*eps);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4800 %!assert(norm(x,Inf), 7);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4801 %!assert(norm(x,-Inf), 1);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4802 %!assert(norm(x,"inf"), 7);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4803 %!assert(norm(x,"fro"), 10, -eps);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4804 %!assert(norm(x), 10);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4805 %!assert(norm([1e200, 1]), 1e200);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4806 %!assert(norm([3+4i, 3-4i, sqrt(31)]), 9, -4*eps);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4807 %!shared m
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4808 %! m = magic (4);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4809 %!assert(norm(m,1), 34);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4810 %!assert(norm(m,2), 34, -eps);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4811 %!assert(norm(m,Inf), 34);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4812 %!assert(norm(m,"inf"), 34);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4813 %!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	4814 %! 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	4815 %! 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	4816 %! fhi = 1e+300;
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4817 %!assert (norm(flom2,"fro"), sqrt(30)flo, -eps)
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4818 %!assert (norm(fhim2,"fro"), sqrt(30)fhi, -eps)
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4819
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4820 %!shared x
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4821 %! x = single([1, -3, 4, 5, -7]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4822 %!assert(norm(x,1), single(20));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4823 %!assert(norm(x,2), single(10));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4824 %!assert(norm(x,3), single(8.24257059961711), -4*eps('single'));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4825 %!assert(norm(x,Inf), single(7));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4826 %!assert(norm(x,-Inf), single(1));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4827 %!assert(norm(x,"inf"), single(7));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4828 %!assert(norm(x,"fro"), single(10), -eps('single'));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4829 %!assert(norm(x), single(10));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4830 %!assert(norm(single([1e200, 1])), single(1e200));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4831 %!assert(norm(single([3+4i, 3-4i, sqrt(31)])), single(9), -4*eps('single'));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4832 %!shared m
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4833 %! m = single(magic (4));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4834 %!assert(norm(m,1), single(34));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4835 %!assert(norm(m,2), single(34), -eps('single'));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4836 %!assert(norm(m,Inf), single(34));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4837 %!assert(norm(m,"inf"), single(34));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4838 %!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	4839 %! m2 = single([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	4840 %! flo = single(1e-300);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4841 %! fhi = single(1e+300);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4842 %!assert (norm(flom2,"fro"), single(sqrt(30)flo), -eps('single'))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4843 %!assert (norm(fhim2,"fro"), single(sqrt(30)fhi), -eps('single'))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4844 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4845
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4846 static octave_value
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4847 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	4848 const octave_value_list& args)
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4849 {
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4850 octave_value retval;
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4851 if (args.length () == 1)
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4852 retval = do_unary_op (op, args(0));
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4853 else
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4854 print_usage ();
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4855
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4856 return retval;
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4857 }
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4858
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4859 DEFUN (not, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4860 "-- texinfo --\n\
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4861 @deftypefn {Built-in Function} {} not (@var{x})\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	4862 Return the logical NOT of @var{x}. This function is equivalent to\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	4863 @code{! x}.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	4864 @seealso{and, or}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4865 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4866 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4867 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	4868 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4869
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4870 DEFUN (uplus, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4871 "-- texinfo --\n\
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4872 @deftypefn {Built-in Function} {} uplus (@var{x})\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	4873 This function is equivalent to @w{@code{+ x}}.\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4874 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4875 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4876 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	4877 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4878
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4879 DEFUN (uminus, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4880 "-- texinfo --\n\
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4881 @deftypefn {Built-in Function} {} uminus (@var{x})\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	4882 This function is equivalent to @w{@code{- x}}.\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4883 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4884 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4885 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	4886 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4887
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4888 DEFUN (transpose, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4889 "-- texinfo --\n\
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4890 @deftypefn {Built-in Function} {} transpose (@var{x})\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	4891 Return the transpose of @var{x}. This function is equivalent to @code{x.'}.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	4892 @seealso{ctranspose}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4893 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4894 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4895 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	4896 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4897
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4898 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4899
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4900 %!assert (2.', 2);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4901 %!assert (2i.',2i);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4902 %!assert ([1:4].',[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	4903 %!assert ([1;2;3;4].',[1:4]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4904 %!assert ([1,2;3,4].',[1,3;2,4]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4905 %!assert ([1,2i;3,4].',[1,3;2i,4]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4906
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4907 %!assert (transpose ([1,2;3,4]),[1,3;2,4]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4908
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4909 %!assert (single(2).', single(2));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4910 %!assert (single(2i).',single(2i));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4911 %!assert (single([1:4]).',single([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	4912 %!assert (single([1;2;3;4]).',single([1:4]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4913 %!assert (single([1,2;3,4]).',single([1,3;2,4]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4914 %!assert (single([1,2i;3,4]).',single([1,3;2i,4]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4915
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4916 %!assert (transpose (single([1,2;3,4])),single([1,3;2,4]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4917
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4918 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4919
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4920 DEFUN (ctranspose, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4921 "-- texinfo --\n\
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4922 @deftypefn {Built-in Function} {} ctranspose (@var{x})\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	4923 Return the complex conjugate transpose of @var{x}. This function is\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	4924 equivalent to @code{x'}.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	4925 @seealso{transpose}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4926 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4927 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4928 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	4929 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4930
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4931 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4932
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4933 %!assert (2', 2);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4934 %!assert (2i',-2i);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4935 %!assert ([1:4]',[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	4936 %!assert ([1;2;3;4]',[1:4]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4937 %!assert ([1,2;3,4]',[1,3;2,4]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4938 %!assert ([1,2i;3,4]',[1,3;-2i,4]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4939
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4940 %!assert (ctranspose ([1,2i;3,4]),[1,3;-2i,4]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4941
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4942 %!assert (single(2)', single(2));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4943 %!assert (single(2i)',single(-2i));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4944 %!assert (single([1:4])',single([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	4945 %!assert (single([1;2;3;4])',single([1:4]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4946 %!assert (single([1,2;3,4])',single([1,3;2,4]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4947 %!assert (single([1,2i;3,4])',single([1,3;-2i,4]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4948
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4949 %!assert (ctranspose (single([1,2i;3,4])),single([1,3;-2i,4]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4950
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4951 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4952
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4953 static octave_value
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4954 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	4955 const octave_value_list& args)
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4956 {
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4957 octave_value retval;
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4958
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4959 if (args.length () == 2)
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4960 retval = do_binary_op (op, args(0), args(1));
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4961 else
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4962 print_usage ();
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4963
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4964 return retval;
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4965 }
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4966
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4967 static octave_value
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4968 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	4969 octave_value::assign_op aop,
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4970 const octave_value_list& args)
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4971 {
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4972 octave_value retval;
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4973 int nargin = args.length ();
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4974
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4975 switch (nargin)
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4976 {
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4977 case 0:
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4978 print_usage ();
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4979 break;
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4980 case 1:
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4981 retval = args(0);
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4982 break;
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4983 case 2:
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4984 retval = do_binary_op (op, args(0), args(1));
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4985 break;
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4986 default:
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4987 retval = do_binary_op (op, args(0), args(1));
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4988 for (int i = 2; i < nargin; i++)
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4989 retval.assign (aop, args(i));
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4990 break;
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4991 }
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4992
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4993 return retval;
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	4994 }
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	4995
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4996 DEFUN (plus, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	4997 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	4998 @deftypefn {Built-in Function} {} plus (@var{x}, @var{y})\n\
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	4999 @deftypefnx {Built-in Function} {} plus (@var{x1}, @var{x2}, @dots{})\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5000 This function is equivalent to @w{@code{x + y}}.\n\
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5001 If more arguments are given, the summation is applied\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5002 cumulatively from left to right:\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5003 \n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5004 @example\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5005 (@dots{}((x1 + x2) + x3) + @dots{})\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5006 @end example\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5007 \n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5008 At least one argument is required.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5009 @seealso{minus}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5010 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5011 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	5012 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	5013 octave_value::op_add_eq, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5014 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5015
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5016 DEFUN (minus, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5017 "-- texinfo --\n\
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5018 @deftypefn {Built-in Function} {} minus (@var{x}, @var{y})\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5019 This function is equivalent to @w{@code{x - y}}.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5020 @seealso{plus}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5021 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5022 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	5023 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	5024 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5025
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5026 DEFUN (mtimes, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5027 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	5028 @deftypefn {Built-in Function} {} mtimes (@var{x}, @var{y})\n\
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5029 @deftypefnx {Built-in Function} {} mtimes (@var{x1}, @var{x2}, @dots{})\n\
11575 d6619410e79c Spellcheck documentation before 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11572 diff changeset	5030 Return the matrix multiplication product of inputs.\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5031 This function is equivalent to @w{@code{x * y}}.\n\
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5032 If more arguments are given, the multiplication is applied\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5033 cumulatively from left to right:\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5034 \n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5035 @example\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5036 (@dots{}((x1 * x2) * x3) * @dots{})\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5037 @end example\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5038 \n\
11575 d6619410e79c Spellcheck documentation before 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11572 diff changeset	5039 At least one argument is required.\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5040 @seealso{times}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5041 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5042 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	5043 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	5044 octave_value::op_mul_eq, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5045 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5046
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5047 DEFUN (mrdivide, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5048 "-- texinfo --\n\
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5049 @deftypefn {Built-in Function} {} mrdivide (@var{x}, @var{y})\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5050 Return the matrix right division of @var{x} and @var{y}.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5051 This function is equivalent to @w{@code{x / y}}.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5052 @seealso{mldivide, rdivide}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5053 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5054 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	5055 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	5056 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5057
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5058 DEFUN (mpower, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5059 "-- texinfo --\n\
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5060 @deftypefn {Built-in Function} {} mpower (@var{x}, @var{y})\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5061 Return the matrix power operation of @var{x} raised to the @var{y} power.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5062 This function is equivalent to @w{@code{x ^ y}}.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5063 @seealso{power}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5064 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5065 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	5066 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	5067 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5068
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5069 DEFUN (mldivide, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5070 "-- texinfo --\n\
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5071 @deftypefn {Built-in Function} {} mldivide (@var{x}, @var{y})\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5072 Return the matrix left division of @var{x} and @var{y}.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5073 This function is equivalent to @w{@code{x \\ y}}.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5074 @seealso{mrdivide, ldivide}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5075 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5076 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	5077 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	5078 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5079
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5080 DEFUN (lt, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5081 "-- texinfo --\n\
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5082 @deftypefn {Built-in Function} {} lt (@var{x}, @var{y})\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5083 This function is equivalent to @w{@code{x < y}}.\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5084 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5085 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	5086 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	5087 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5088
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5089 DEFUN (le, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5090 "-- texinfo --\n\
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5091 @deftypefn {Built-in Function} {} le (@var{x}, @var{y})\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5092 This function is equivalent to @w{@code{x <= y}}.\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5093 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5094 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	5095 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	5096 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5097
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5098 DEFUN (eq, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5099 "-- texinfo --\n\
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5100 @deftypefn {Built-in Function} {} eq (@var{x}, @var{y})\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5101 Return true if the two inputs are equal.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5102 This function is equivalent to @w{@code{x == y}}.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5103 @seealso{ne, isequal}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5104 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5105 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	5106 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	5107 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5108
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5109 DEFUN (ge, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5110 "-- texinfo --\n\
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5111 @deftypefn {Built-in Function} {} ge (@var{x}, @var{y})\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5112 This function is equivalent to @w{@code{x >= y}}.\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5113 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5114 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	5115 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	5116 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5117
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5118 DEFUN (gt, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5119 "-- texinfo --\n\
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5120 @deftypefn {Built-in Function} {} gt (@var{x}, @var{y})\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5121 This function is equivalent to @w{@code{x > y}}.\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5122 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5123 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	5124 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	5125 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5126
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5127 DEFUN (ne, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5128 "-- texinfo --\n\
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5129 @deftypefn {Built-in Function} {} ne (@var{x}, @var{y})\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5130 Return true if the two inputs are not equal.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5131 This function is equivalent to @w{@code{x != y}}.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5132 @seealso{eq, isequal}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5133 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5134 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	5135 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	5136 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5137
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5138 DEFUN (times, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5139 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	5140 @deftypefn {Built-in Function} {} times (@var{x}, @var{y})\n\
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5141 @deftypefnx {Built-in Function} {} times (@var{x1}, @var{x2}, @dots{})\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5142 Return the element-by-element multiplication product of inputs.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5143 This function is equivalent to @w{@code{x .* y}}.\n\
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5144 If more arguments are given, the multiplication is applied\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5145 cumulatively from left to right:\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5146 \n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5147 @example\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5148 (@dots{}((x1 .* x2) .* x3) .* @dots{})\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5149 @end example\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5150 \n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5151 At least one argument is required.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5152 @seealso{mtimes}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5153 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5154 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	5155 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	5156 octave_value::op_el_mul_eq, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5157 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5158
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5159 DEFUN (rdivide, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5160 "-- texinfo --\n\
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5161 @deftypefn {Built-in Function} {} rdivide (@var{x}, @var{y})\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5162 Return the element-by-element right division of @var{x} and @var{y}.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5163 This function is equivalent to @w{@code{x ./ y}}.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5164 @seealso{ldivide, mrdivide}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5165 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5166 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	5167 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	5168 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5169
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5170 DEFUN (power, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5171 "-- texinfo --\n\
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5172 @deftypefn {Built-in Function} {} power (@var{x}, @var{y})\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5173 Return the element-by-element operation of @var{x} raised to the\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5174 @var{y} power.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5175 This function is equivalent to @w{@code{x .^ y}}.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5176 @seealso{mpower}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5177 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5178 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	5179 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	5180 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5181
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5182 DEFUN (ldivide, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5183 "-- texinfo --\n\
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5184 @deftypefn {Built-in Function} {} ldivide (@var{x}, @var{y})\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5185 Return the element-by-element left division of @var{x} and @var{y}.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5186 This function is equivalent to @w{@code{x .\\ y}}.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5187 @seealso{rdivide, mldivide}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5188 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5189 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	5190 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	5191 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5192
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5193 DEFUN (and, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5194 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	5195 @deftypefn {Built-in Function} {} and (@var{x}, @var{y})\n\
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5196 @deftypefnx {Built-in Function} {} and (@var{x1}, @var{x2}, @dots{})\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5197 Return the logical AND of @var{x} and @var{y}.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5198 This function is equivalent to @w{@code{x & y}}.\n\
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5199 If more arguments are given, the logical and is applied\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5200 cumulatively from left to right:\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5201 \n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5202 @example\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5203 (@dots{}((x1 & x2) & x3) & @dots{})\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5204 @end example\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5205 \n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5206 At least one argument is required.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5207 @seealso{or, not}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5208 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5209 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	5210 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	5211 octave_value::op_el_and_eq, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5212 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5213
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5214 DEFUN (or, args, ,
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5215 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	5216 @deftypefn {Built-in Function} {} or (@var{x}, @var{y})\n\
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5217 @deftypefnx {Built-in Function} {} or (@var{x1}, @var{x2}, @dots{})\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5218 Return the logical OR of @var{x} and @var{y}.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5219 This function is equivalent to @w{@code{x \| y}}.\n\
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5220 If more arguments are given, the logical or is applied\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5221 cumulatively from left to right:\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5222 \n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5223 @example\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5224 (@dots{}((x1 \| x2) \| x3) \| @dots{})\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5225 @end example\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	5226 \n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5227 At least one argument is required.\n\
3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	5228 @seealso{and, not}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5229 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5230 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	5231 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	5232 octave_value::op_el_or_eq, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5233 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	5234
7065 97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	5235 static double tic_toc_timestamp = -1.0;
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5236
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5237 DEFUN (tic, args, nargout,
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5238 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	5239 @deftypefn {Built-in Function} {} tic ()\n\
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5240 @deftypefnx {Built-in Function} {} toc ()\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5241 Set or check a wall-clock timer. Calling @code{tic} without an\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5242 output argument sets the timer. Subsequent calls to @code{toc}\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5243 return the number of seconds since the timer was set. For example,\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5244 \n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5245 @example\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	5246 @group\n\
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5247 tic ();\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	5248 # many computations later@dots{}\n\
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5249 elapsed_time = toc ();\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	5250 @end group\n\
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5251 @end example\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5252 \n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5253 @noindent\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5254 will set the variable @code{elapsed_time} to the number of seconds since\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5255 the most recent call to the function @code{tic}.\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5256 \n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5257 If called with one output argument then this function returns a scalar\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5258 of type @code{uint64} and the wall-clock timer is not started.\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5259 \n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5260 @example\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5261 @group\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5262 t = tic; sleep (5); (double (tic ()) - double (t)) * 1e-6\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5263 @result{} 5\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5264 @end group\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5265 @end example\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5266 \n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5267 Nested timing with @code{tic} and @code{toc} is not supported.\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5268 Therefore @code{toc} will always return the elapsed time from the most\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5269 recent call to @code{tic}.\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5270 \n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5271 If you are more interested in the CPU time that your process used, you\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5272 should use the @code{cputime} function instead. The @code{tic} and\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5273 @code{toc} functions report the actual wall clock time that elapsed\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5274 between the calls. This may include time spent processing other jobs or\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	5275 doing nothing at all. For example:\n\
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5276 \n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5277 @example\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5278 @group\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5279 tic (); sleep (5); toc ()\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5280 @result{} 5\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5281 t = cputime (); sleep (5); cputime () - t\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5282 @result{} 0\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5283 @end group\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5284 @end example\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5285 \n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5286 @noindent\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5287 (This example also illustrates that the CPU timer may have a fairly\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5288 coarse resolution.)\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5289 @end deftypefn")
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5290 {
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5291 octave_value retval;
7065 97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	5292
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5293 int nargin = args.length ();
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5294
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5295 if (nargin != 0)
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5296 warning ("tic: ignoring extra arguments");
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5297
7065 97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	5298 octave_time now;
97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	5299
97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	5300 double tmp = now.double_value ();
97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	5301
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5302 if (nargout > 0)
7065 97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	5303 retval = static_cast<octave_uint64> (1e6 * tmp);
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5304 else
7065 97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	5305 tic_toc_timestamp = tmp;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	5306
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5307 return retval;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5308 }
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5309
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5310 DEFUN (toc, args, nargout,
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5311 "-- texinfo --\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5312 @deftypefn {Built-in Function} {} toc ()\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5313 See tic.\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5314 @end deftypefn")
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5315 {
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5316 octave_value retval;
7065 97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	5317
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5318 int nargin = args.length ();
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5319
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5320 if (nargin != 0)
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5321 warning ("tic: ignoring extra arguments");
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5322
7065 97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	5323 if (tic_toc_timestamp < 0)
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5324 {
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5325 warning ("toc called before timer set");
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5326 if (nargout > 0)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5327 retval = Matrix ();
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5328 }
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5329 else
7065 97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	5330 {
97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	5331 octave_time now;
97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	5332
97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	5333 double tmp = now.double_value () - tic_toc_timestamp;
97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	5334
97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	5335 if (nargout > 0)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5336 retval = tmp;
7065 97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	5337 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5338 octave_stdout << "Elapsed time is " << tmp << " seconds.\n";
7065 97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	5339 }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	5340
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5341 return retval;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5342 }
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5343
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5344 DEFUN (cputime, args, ,
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5345 "-- texinfo --\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5346 @deftypefn {Built-in Function} {[@var{total}, @var{user}, @var{system}] =} cputime ();\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5347 Return the CPU time used by your Octave session. The first output is\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5348 the total time spent executing your process and is equal to the sum of\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5349 second and third outputs, which are the number of CPU seconds spent\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5350 executing in user mode and the number of CPU seconds spent executing in\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5351 system mode, respectively. If your system does not have a way to report\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5352 CPU time usage, @code{cputime} returns 0 for each of its output values.\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5353 Note that because Octave used some CPU time to start, it is reasonable\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5354 to check to see if @code{cputime} works by checking to see if the total\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5355 CPU time used is nonzero.\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5356 @end deftypefn")
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5357 {
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5358 octave_value_list retval;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5359 int nargin = args.length ();
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5360 double usr = 0.0;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5361 double sys = 0.0;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5362
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5363 if (nargin != 0)
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5364 warning ("tic: ignoring extra arguments");
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5365
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5366 #if defined (HAVE_GETRUSAGE)
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5367
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5368 struct rusage ru;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5369
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5370 getrusage (RUSAGE_SELF, &ru);
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5371
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5372 usr = static_cast<double> (ru.ru_utime.tv_sec) +
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5373 static_cast<double> (ru.ru_utime.tv_usec) * 1e-6;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5374
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5375 sys = static_cast<double> (ru.ru_stime.tv_sec) +
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5376 static_cast<double> (ru.ru_stime.tv_usec) * 1e-6;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5377
10240 fa7b5751730c use gnulib time, sys_time, and sys_times modules John W. Eaton <jwe@octave.org> parents: 10185 diff changeset	5378 #else
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5379
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5380 struct tms t;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5381
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5382 times (&t);
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5383
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5384 unsigned long ticks;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5385 unsigned long seconds;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5386 unsigned long fraction;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5387
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5388 ticks = t.tms_utime + t.tms_cutime;
10303 e4899d6320b6 data.cc: use CLOCKS_PER_SEC instead of HZ John W. Eaton <jwe@octave.org> parents: 10302 diff changeset	5389 fraction = ticks % CLOCKS_PER_SEC;
e4899d6320b6 data.cc: use CLOCKS_PER_SEC instead of HZ John W. Eaton <jwe@octave.org> parents: 10302 diff changeset	5390 seconds = ticks / CLOCKS_PER_SEC;
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5391
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5392 usr = static_cast<double> (seconds) + static_cast<double>(fraction) /
10303 e4899d6320b6 data.cc: use CLOCKS_PER_SEC instead of HZ John W. Eaton <jwe@octave.org> parents: 10302 diff changeset	5393 static_cast<double>(CLOCKS_PER_SEC);
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5394
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5395 ticks = t.tms_stime + t.tms_cstime;
10303 e4899d6320b6 data.cc: use CLOCKS_PER_SEC instead of HZ John W. Eaton <jwe@octave.org> parents: 10302 diff changeset	5396 fraction = ticks % CLOCKS_PER_SEC;
e4899d6320b6 data.cc: use CLOCKS_PER_SEC instead of HZ John W. Eaton <jwe@octave.org> parents: 10302 diff changeset	5397 seconds = ticks / CLOCKS_PER_SEC;
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5398
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5399 sys = static_cast<double> (seconds) + static_cast<double>(fraction) /
10303 e4899d6320b6 data.cc: use CLOCKS_PER_SEC instead of HZ John W. Eaton <jwe@octave.org> parents: 10302 diff changeset	5400 static_cast<double>(CLOCKS_PER_SEC);
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5401
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5402 #endif
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5403
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5404 retval (2) = sys;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5405 retval (1) = usr;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5406 retval (0) = sys + usr;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5407
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5408 return retval;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5409 }
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	5410
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5411 DEFUN (sort, args, nargout,
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5412 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	5413 @deftypefn {Loadable Function} {[@var{s}, @var{i}] =} sort (@var{x})\n\
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5414 @deftypefnx {Loadable Function} {[@var{s}, @var{i}] =} sort (@var{x}, @var{dim})\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5415 @deftypefnx {Loadable Function} {[@var{s}, @var{i}] =} sort (@var{x}, @var{mode})\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5416 @deftypefnx {Loadable Function} {[@var{s}, @var{i}] =} sort (@var{x}, @var{dim}, @var{mode})\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5417 Return a copy of @var{x} with the elements arranged in increasing\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5418 order. For matrices, @code{sort} orders the elements in each column.\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5419 \n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	5420 For example:\n\
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5421 \n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5422 @example\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5423 @group\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5424 sort ([1, 2; 2, 3; 3, 1])\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5425 @result{} 1 1\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5426 2 2\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5427 3 3\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5428 @end group\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5429 @end example\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5430 \n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5431 The @code{sort} function may also be used to produce a matrix\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5432 containing the original row indices of the elements in the sorted\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	5433 matrix. For example:\n\
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5434 \n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5435 @example\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5436 @group\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5437 [s, i] = sort ([1, 2; 2, 3; 3, 1])\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5438 @result{} s = 1 1\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5439 2 2\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5440 3 3\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5441 @result{} i = 1 3\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5442 2 1\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5443 3 2\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5444 @end group\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5445 @end example\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5446 \n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5447 If the optional argument @var{dim} is given, then the matrix is sorted\n\
9041 853f96e8008f Cleanup documentation file matrix.texi Rik <rdrider0-list@yahoo.com> parents: 8972 diff changeset	5448 along the dimension defined by @var{dim}. The optional argument @code{mode}\n\
853f96e8008f Cleanup documentation file matrix.texi Rik <rdrider0-list@yahoo.com> parents: 8972 diff changeset	5449 defines the order in which the values will be sorted. Valid values of\n\
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5450 @code{mode} are `ascend' or `descend'.\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5451 \n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5452 For equal elements, the indices are such that the equal elements are listed\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5453 in the order that appeared in the original list.\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5454 \n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5455 The @code{sort} function may also be used to sort strings and cell arrays\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5456 of strings, in which case the dictionary order of the strings is used.\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5457 \n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5458 The algorithm used in @code{sort} is optimized for the sorting of partially\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5459 ordered lists.\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5460 @end deftypefn")
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5461 {
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5462 octave_value_list retval;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5463
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5464 int nargin = args.length ();
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5465 sortmode smode = ASCENDING;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5466
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5467 if (nargin < 1 \|\| nargin > 3)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5468 {
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5469 print_usage ();
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5470 return retval;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5471 }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5472
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5473 bool return_idx = nargout > 1;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5474
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5475 octave_value arg = args(0);
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5476
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5477 int dim = 0;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5478 if (nargin > 1)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5479 {
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5480 if (args(1).is_string ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5481 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5482 std::string mode = args(1).string_value();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5483 if (mode == "ascend")
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5484 smode = ASCENDING;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5485 else if (mode == "descend")
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5486 smode = DESCENDING;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5487 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5488 {
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	5489 error ("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	5490 return retval;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5491 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5492 }
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5493 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5494 dim = args(1).nint_value () - 1;
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5495 }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5496
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5497 if (nargin > 2)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5498 {
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5499 if (args(1).is_string ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5500 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5501 print_usage ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5502 return retval;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5503 }
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5504
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5505 if (! args(2).is_string ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5506 {
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	5507 error ("sort: MODE must be a string");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5508 return retval;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5509 }
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5510 std::string mode = args(2).string_value();
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5511 if (mode == "ascend")
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5512 smode = ASCENDING;
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5513 else if (mode == "descend")
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5514 smode = DESCENDING;
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5515 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5516 {
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	5517 error ("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	5518 return retval;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5519 }
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5520 }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5521
10285 22a7913bbeb5 optimize return values of find and sort Jaroslav Hajek <highegg@gmail.com> parents: 10277 diff changeset	5522 const dim_vector dv = arg.dims ();
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5523 if (nargin == 1 \|\| args(1).is_string ())
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5524 {
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5525 // Find first non singleton dimension
10285 22a7913bbeb5 optimize return values of find and sort Jaroslav Hajek <highegg@gmail.com> parents: 10277 diff changeset	5526 dim = dv.first_non_singleton ();
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5527 }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5528 else
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5529 {
10703 5eb420d92307 fix sort and nth_element when trailing singleton dim is specified Jaroslav Hajek <highegg@gmail.com> parents: 10695 diff changeset	5530 if (dim < 0)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5531 {
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	5532 error ("sort: DIM must be a valid dimension");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5533 return retval;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5534 }
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5535 }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5536
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5537 if (return_idx)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5538 {
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5539 Array<octave_idx_type> sidx;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5540
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5541 retval (0) = arg.sort (sidx, dim, smode);
10285 22a7913bbeb5 optimize return values of find and sort Jaroslav Hajek <highegg@gmail.com> parents: 10277 diff changeset	5542 retval (1) = idx_vector (sidx, dv(dim)); // No checking, the extent is known.
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5543 }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5544 else
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5545 retval(0) = arg.sort (dim, smode);
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5546
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5547 return retval;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5548 }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5549
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5550 /*
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5551
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5552 %% Double
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5553 %!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	5554 %!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	5555 %!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	5556 %!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	5557 %!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	5558 %!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	5559 %!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	5560 %!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	5561 %!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	5562 %!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	5563 %!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	5564 %!assert (sort (1), 1)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5565
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5566 %!test
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5567 %! [v, i] = sort ([NaN, 1, -1, Inf, 1]);
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5568 %! assert (v, [-1, 1, 1, Inf, NaN])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5569 %! assert (i, [3, 2, 5, 4, 1])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5570
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5571 %% Complex
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5572 %!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	5573 %!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	5574 %!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	5575 %!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	5576 %!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	5577 %!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	5578 %!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	5579 %!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	5580 %!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	5581 %!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	5582 %!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	5583 %!assert (sort (1i), 1i)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5584
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5585 %!test
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5586 %! [v, i] = sort ([NaN, 1i, -1, Inf, 1, 1i]);
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5587 %! assert (v, [1, 1i, 1i, -1, Inf, NaN])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5588 %! assert (i, [5, 2, 6, 3, 4, 1])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5589
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5590 %% Single
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5591 %!assert (sort (single([NaN, 1, -1, 2, Inf])), single([-1, 1, 2, Inf, NaN]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5592 %!assert (sort (single([NaN, 1, -1, 2, Inf]), 1), single([NaN, 1, -1, 2, Inf]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5593 %!assert (sort (single([NaN, 1, -1, 2, Inf]), 2), single([-1, 1, 2, Inf, NaN]))
10707 69c5f5ec55d7 fix invalid sort tests Jaroslav Hajek <highegg@gmail.com> parents: 10703 diff changeset	5594 %!assert (sort (single([NaN, 1, -1, 2, Inf]), 3), single([NaN, 1, -1, 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	5595 %!assert (sort (single([NaN, 1, -1, 2, Inf]), "ascend"), single([-1, 1, 2, Inf, NaN]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5596 %!assert (sort (single([NaN, 1, -1, 2, Inf]), 2, "ascend"), single([-1, 1, 2, Inf, NaN]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5597 %!assert (sort (single([NaN, 1, -1, 2, Inf]), "descend"), single([NaN, Inf, 2, 1, -1]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5598 %!assert (sort (single([NaN, 1, -1, 2, Inf]), 2, "descend"), single([NaN, Inf, 2, 1, -1]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5599 %!assert (sort (single([3, 1, 7, 5; 8, 2, 6, 4])), single([3, 1, 6, 4; 8, 2, 7, 5]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5600 %!assert (sort (single([3, 1, 7, 5; 8, 2, 6, 4]), 1), single([3, 1, 6, 4; 8, 2, 7, 5]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5601 %!assert (sort (single([3, 1, 7, 5; 8, 2, 6, 4]), 2), single([1, 3, 5, 7; 2, 4, 6, 8]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5602 %!assert (sort (single(1)), single(1))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5603
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5604 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5605 %! [v, i] = sort (single([NaN, 1, -1, Inf, 1]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5606 %! assert (v, single([-1, 1, 1, Inf, NaN]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5607 %! assert (i, [3, 2, 5, 4, 1])
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5608
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5609 %% Single Complex
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5610 %!assert (sort (single([NaN, 1i, -1, 2, Inf])), single([1i, -1, 2, Inf, NaN]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5611 %!assert (sort (single([NaN, 1i, -1, 2, Inf]), 1), single([NaN, 1i, -1, 2, Inf]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5612 %!assert (sort (single([NaN, 1i, -1, 2, Inf]), 2), single([1i, -1, 2, Inf, NaN]))
10707 69c5f5ec55d7 fix invalid sort tests Jaroslav Hajek <highegg@gmail.com> parents: 10703 diff changeset	5613 %!assert (sort (single([NaN, 1i, -1, 2, Inf]), 3), single([NaN, 1i, -1, 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	5614 %!assert (sort (single([NaN, 1i, -1, 2, Inf]), "ascend"), single([1i, -1, 2, Inf, NaN]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5615 %!assert (sort (single([NaN, 1i, -1, 2, Inf]), 2, "ascend"), single([1i, -1, 2, Inf, NaN]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5616 %!assert (sort (single([NaN, 1i, -1, 2, Inf]), "descend"), single([NaN, Inf, 2, -1, 1i]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5617 %!assert (sort (single([NaN, 1i, -1, 2, Inf]), 2, "descend"), single([NaN, Inf, 2, -1, 1i]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5618 %!assert (sort (single([3, 1i, 7, 5; 8, 2, 6, 4])), single([3, 1i, 6, 4; 8, 2, 7, 5]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5619 %!assert (sort (single([3, 1i, 7, 5; 8, 2, 6, 4]), 1), single([3, 1i, 6, 4; 8, 2, 7, 5]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5620 %!assert (sort (single([3, 1i, 7, 5; 8, 2, 6, 4]), 2), single([1i, 3, 5, 7; 2, 4, 6, 8]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5621 %!assert (sort (single(1i)),single( 1i))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5622
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5623 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5624 %! [v, i] = sort (single([NaN, 1i, -1, Inf, 1, 1i]));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5625 %! assert (v, single([1, 1i, 1i, -1, Inf, NaN]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5626 %! assert (i, [5, 2, 6, 3, 4, 1])
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5627
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5628 %% Bool
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5629 %!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	5630 %!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	5631 %!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	5632 %!assert (sort ([true, false, true, false], 3), [true, false, true, false])
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5633 %!assert (sort ([true, false, true, false], "ascend"), [false, false, true, true])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5634 %!assert (sort ([true, false, true, false], 2, "ascend"), [false, false, true, true])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5635 %!assert (sort ([true, false, true, false], "descend"), [true, true, false, false])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5636 %!assert (sort ([true, false, true, false], 2, "descend"), [true, true, false, false])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5637 %!assert (sort (true), true)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5638
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5639 %!test
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5640 %! [v, i] = sort ([true, false, true, false]);
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5641 %! assert (v, [false, false, true, true])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5642 %! assert (i, [2, 4, 1, 3])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5643
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5644 %% Sparse Double
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5645 %!assert (sort (sparse ([0, NaN, 1, 0, -1, 2, Inf])), sparse ([-1, 0, 0, 1, 2, Inf, NaN]))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5646 %!assert (sort (sparse ([0, NaN, 1, 0, -1, 2, Inf]), 1), sparse ([0, NaN, 1, 0, -1, 2, Inf]))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5647 %!assert (sort (sparse ([0, NaN, 1, 0, -1, 2, Inf]), 2), sparse ([-1, 0, 0, 1, 2, Inf, NaN]))
10707 69c5f5ec55d7 fix invalid sort tests Jaroslav Hajek <highegg@gmail.com> parents: 10703 diff changeset	5648 %!assert (sort (sparse ([0, NaN, 1, 0, -1, 2, Inf]), 3), sparse ([0, NaN, 1, 0, -1, 2, Inf]))
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5649 %!assert (sort (sparse ([0, NaN, 1, 0, -1, 2, Inf]), "ascend"), sparse ([-1, 0, 0, 1, 2, Inf, NaN]))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5650 %!assert (sort (sparse ([0, NaN, 1, 0, -1, 2, Inf]), 2, "ascend"), sparse ([-1, 0, 0, 1, 2, Inf, NaN]))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5651 %!assert (sort (sparse ([0, NaN, 1, 0, -1, 2, Inf]), "descend"), sparse ([NaN, Inf, 2, 1, 0, 0, -1]))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5652 %!assert (sort (sparse ([0, NaN, 1, 0, -1, 2, Inf]), 2, "descend"), sparse ([NaN, Inf, 2, 1, 0, 0, -1]))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5653
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5654 %!shared a
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5655 %! a = randn (10, 10);
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5656 %! a (a < 0) = 0;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5657 %!assert (sort (sparse (a)), sparse (sort (a)))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5658 %!assert (sort (sparse (a), 1), sparse (sort (a, 1)))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5659 %!assert (sort (sparse (a), 2), sparse (sort (a, 2)))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5660 %!test
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5661 %! [v, i] = sort (a);
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5662 %! [vs, is] = sort (sparse (a));
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5663 %! assert (vs, sparse (v))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5664 %! assert (is, i)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5665
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5666 %% Sparse Complex
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5667 %!assert (sort (sparse ([0, NaN, 1i, 0, -1, 2, Inf])), sparse ([0, 0, 1i, -1, 2, Inf, NaN]))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5668 %!assert (sort (sparse ([0, NaN, 1i, 0, -1, 2, Inf]), 1), sparse ([0, NaN, 1i, 0, -1, 2, Inf]))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5669 %!assert (sort (sparse ([0, NaN, 1i, 0, -1, 2, Inf]), 2), sparse ([0, 0, 1i, -1, 2, Inf, NaN]))
10707 69c5f5ec55d7 fix invalid sort tests Jaroslav Hajek <highegg@gmail.com> parents: 10703 diff changeset	5670 %!assert (sort (sparse ([0, NaN, 1i, 0, -1, 2, Inf]), 3), sparse ([0, NaN, 1i, 0, -1, 2, Inf]))
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5671 %!assert (sort (sparse ([0, NaN, 1i, 0, -1, 2, Inf]), "ascend"), sparse ([0, 0, 1i, -1, 2, Inf, NaN]))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5672 %!assert (sort (sparse ([0, NaN, 1i, 0, -1, 2, Inf]), 2, "ascend"), sparse ([0, 0, 1i, -1, 2, Inf, NaN]))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5673 %!assert (sort (sparse ([0, NaN, 1i, 0, -1, 2, Inf]), "descend"), sparse ([NaN, Inf, 2, -1, 1i, 0, 0]))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5674 %!assert (sort (sparse ([0, NaN, 1i, 0, -1, 2, Inf]), 2, "descend"), sparse ([NaN, Inf, 2, -1, 1i, 0, 0]))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5675
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5676 %!shared a
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	5677 %! a = randn (10, 10);
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5678 %! a (a < 0) = 0;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5679 %! a = 1i * a;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5680 %!assert (sort (sparse (a)), sparse (sort (a)))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5681 %!assert (sort (sparse (a), 1), sparse (sort (a, 1)))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5682 %!assert (sort (sparse (a), 2), sparse (sort (a, 2)))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5683 %!test
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5684 %! [v, i] = sort (a);
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5685 %! [vs, is] = sort (sparse (a));
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5686 %! assert (vs, sparse (v))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5687 %! assert (is, i)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5688
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5689 %% Sparse Bool
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5690 %!assert (sort (sparse ([true, false, true, false])), sparse ([false, false, true, true]))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5691 %!assert (sort (sparse([true, false, true, false]), 1), sparse ([true, false, true, false]))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5692 %!assert (sort (sparse ([true, false, true, false]), 2), sparse ([false, false, true, true]))
10707 69c5f5ec55d7 fix invalid sort tests Jaroslav Hajek <highegg@gmail.com> parents: 10703 diff changeset	5693 %!assert (sort (sparse ([true, false, true, false]), 3), sparse ([true, false, true, false]))
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5694 %!assert (sort (sparse ([true, false, true, false]), "ascend"), sparse([false, false, true, true]))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5695 %!assert (sort (sparse ([true, false, true, false]), 2, "ascend"), sparse([false, false, true, true]))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5696 %!assert (sort (sparse ([true, false, true, false]), "descend"), sparse ([true, true, false, false]))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5697 %!assert (sort (sparse ([true, false, true, false]), 2, "descend"), sparse([true, true, false, false]))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5698
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5699 %!test
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5700 %! [v, i] = sort (sparse([true, false, true, false]));
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5701 %! assert (v, sparse([false, false, true, true]))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5702 %! assert (i, [2, 4, 1, 3])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5703
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5704 %% Cell string array
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5705 %!shared a, b, c
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5706 %! a = {"Alice", "Cecile", "Eric", "Barry", "David"};
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5707 %! b = {"Alice", "Barry", "Cecile", "David", "Eric"};
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5708 %! c = {"Eric", "David", "Cecile", "Barry", "Alice"};
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5709 %!assert (sort (a), b);
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5710 %!assert (sort (a, 1), a)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5711 %!assert (sort (a, 2), b)
10707 69c5f5ec55d7 fix invalid sort tests Jaroslav Hajek <highegg@gmail.com> parents: 10703 diff changeset	5712 %!assert (sort (a, 3), a)
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5713 %!assert (sort (a, "ascend"), b)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5714 %!assert (sort (a, 2, "ascend"), b)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5715 %!assert (sort (a, "descend"), c)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5716 %!assert (sort (a, 2, "descend"), c)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5717
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5718 %!test
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5719 %! [v, i] = sort (a);
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5720 %! assert (i, [1, 4, 2, 5, 3])
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5721
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5722 %!error <Invalid call to sort.*> sort ();
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5723 %!error <Invalid call to sort.*> sort (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	5724
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5725 */
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	5726
8812 7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8799 diff changeset	5727 // Sort the rows of the matrix @var{a} according to the order
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8799 diff changeset	5728 // specified by @var{mode}, which can either be `ascend' or `descend'
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8799 diff changeset	5729 // and return the index vector corresponding to the sort order.
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8799 diff changeset	5730 //
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8799 diff changeset	5731 // This function does not yet support sparse matrices.
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8799 diff changeset	5732
8733 3ef774603887 rename all uses of sortrows_idx to sort_rows_idx John W. Eaton <jwe@octave.org> parents: 8721 diff changeset	5733 DEFUN (__sort_rows_idx__, args, ,
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5734 "-- texinfo --\n\
9517 a85dbf7b6ff9 fix some functions help markup Jaroslav Hajek <highegg@gmail.com> parents: 9513 diff changeset	5735 @deftypefn {Built-in Function} {} __sort_rows_idx__ (@var{a}, @var{mode})\n\
8812 7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8799 diff changeset	5736 Undocumented internal function.\n\
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5737 @end deftypefn\n")
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5738 {
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5739 octave_value retval;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5740
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5741 int nargin = args.length ();
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5742 sortmode smode = ASCENDING;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5743
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5744 if (nargin < 1 \|\| nargin > 2 \|\| (nargin == 2 && ! args(1).is_string ()))
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5745 {
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5746 print_usage ();
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5747 return retval;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5748 }
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5749
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5750 if (nargin > 1)
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5751 {
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5752 std::string mode = args(1).string_value();
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5753 if (mode == "ascend")
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5754 smode = ASCENDING;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5755 else if (mode == "descend")
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5756 smode = DESCENDING;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5757 else
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5758 {
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	5759 error ("__sort_rows_idx__: MODE must be either \"ascend\" or \"descend\"");
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5760 return retval;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5761 }
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5762 }
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5763
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5764 octave_value arg = args(0);
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5765
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5766 if (arg.is_sparse_type ())
8733 3ef774603887 rename all uses of sortrows_idx to sort_rows_idx John W. Eaton <jwe@octave.org> parents: 8721 diff changeset	5767 error ("__sort_rows_idx__: sparse matrices not yet supported");
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5768 if (arg.ndims () == 2)
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5769 {
8733 3ef774603887 rename all uses of sortrows_idx to sort_rows_idx John W. Eaton <jwe@octave.org> parents: 8721 diff changeset	5770 Array<octave_idx_type> idx = arg.sort_rows_idx (smode);
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5771
9351 e2344f4af0cb autocache indices returned from find et al. Jaroslav Hajek <highegg@gmail.com> parents: 9339 diff changeset	5772 retval = octave_value (idx, true, true);
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5773 }
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5774 else
8733 3ef774603887 rename all uses of sortrows_idx to sort_rows_idx John W. Eaton <jwe@octave.org> parents: 8721 diff changeset	5775 error ("__sort_rows_idx__: needs a 2-dimensional object");
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5776
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5777 return retval;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5778 }
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5779
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5780 static sortmode
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5781 get_sort_mode_option (const octave_value& arg, const char *argn)
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5782 {
10076 4b270d1540f7 avoid various GCC warnings John W. Eaton <jwe@octave.org> parents: 10073 diff changeset	5783 // FIXME -- we initialize to UNSORTED here to avoid a GCC warning
4b270d1540f7 avoid various GCC warnings John W. Eaton <jwe@octave.org> parents: 10073 diff changeset	5784 // about possibly using sortmode uninitialized.
4b270d1540f7 avoid various GCC warnings John W. Eaton <jwe@octave.org> parents: 10073 diff changeset	5785 // FIXME -- shouldn't these modes be scoped inside a class?
4b270d1540f7 avoid various GCC warnings John W. Eaton <jwe@octave.org> parents: 10073 diff changeset	5786 sortmode smode = UNSORTED;
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5787
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5788 std::string mode = arg.string_value ();
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5789
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5790 if (error_state)
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5791 error ("issorted: expecting %s argument to be a character string", argn);
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5792 else if (mode == "ascending")
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5793 smode = ASCENDING;
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5794 else if (mode == "descending")
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5795 smode = DESCENDING;
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5796 else if (mode == "either")
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5797 smode = UNSORTED;
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5798 else
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	5799 error ("issorted: MODE must be \"ascending\", \"descending\", or \"either\"");
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5800
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5801 return smode;
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5802 }
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5803
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5804 DEFUN (issorted, args, ,
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5805 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	5806 @deftypefn {Built-in Function} {} issorted (@var{a}, @var{mode})\n\
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5807 @deftypefnx {Built-in Function} {} issorted (@var{a}, @code{\"rows\"}, @var{mode})\n\
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	5808 Return true if the array is sorted according to @var{mode}, which\n\
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5809 may be either \"ascending\", \"descending\", or \"either\". By default,\n\
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	5810 @var{mode} is \"ascending\". NaNs are treated in the same manner as\n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	5811 @code{sort}.\n\
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5812 \n\
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	5813 If the optional argument \"rows\" is supplied, check whether\n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	5814 the array is sorted by rows as output by the function @code{sortrows}\n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	5815 (with no options).\n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	5816 \n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	5817 This function does not support sparse matrices.\n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	5818 @seealso{sort, sortrows}\n\
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5819 @end deftypefn\n")
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5820 {
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5821 octave_value retval;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5822
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5823 int nargin = args.length ();
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5824
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5825 if (nargin < 1 \|\| nargin > 3)
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5826 {
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5827 print_usage ();
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5828 return retval;
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5829 }
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5830
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5831 bool by_rows = false;
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5832
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5833 sortmode smode = ASCENDING;
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5834
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5835 if (nargin > 1)
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5836 {
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5837 octave_value mode_arg;
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5838
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5839 if (nargin == 3)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5840 smode = get_sort_mode_option (args(2), "third");
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5841
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5842 std::string tmp = args(1).string_value ();
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5843
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5844 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5845 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5846 if (tmp == "rows")
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5847 by_rows = true;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5848 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5849 smode = get_sort_mode_option (args(1), "second");
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5850 }
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5851 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5852 error ("expecting second argument to be character string");
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5853
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5854 if (error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5855 return retval;
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5856 }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	5857
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5858 octave_value arg = args(0);
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5859
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5860 if (by_rows)
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5861 {
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5862 if (arg.is_sparse_type ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5863 error ("issorted: sparse matrices not yet supported");
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5864 if (arg.ndims () == 2)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5865 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	5866 else
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	5867 error ("issorted: A must be a 2-dimensional object");
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5868 }
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5869 else
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5870 {
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5871 if (arg.dims ().is_vector ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5872 retval = args(0).is_sorted (smode) != UNSORTED;
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5873 else
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5874 error ("issorted: needs a vector");
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5875 }
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5876
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5877 return retval;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5878 }
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	5879
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5880 /*
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5881 %!shared sm, um, sv, uv
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5882 %! sm = [1, 2; 3, 4];
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5883 %! um = [3, 1; 2, 4];
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5884 %! sv = [1, 2, 3, 4];
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5885 %! uv = [2, 1, 4, 3];
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5886 %!assert(issorted (sm, "rows"));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5887 %!assert(!issorted (um, "rows"));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5888 %!assert(issorted (sv));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5889 %!assert(!issorted (uv));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5890 %!assert(issorted (sv'));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5891 %!assert(!issorted (uv'));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5892 %!assert(issorted (sm, "rows", "ascending"));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5893 %!assert(!issorted (um, "rows", "ascending"));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5894 %!assert(issorted (sv, "ascending"));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5895 %!assert(!issorted (uv, "ascending"));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5896 %!assert(issorted (sv', "ascending"));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5897 %!assert(!issorted (uv', "ascending"));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5898 %!assert(!issorted (sm, "rows", "descending"));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5899 %!assert(issorted (flipud (sm), "rows", "descending"));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5900 %!assert(!issorted (sv, "descending"));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5901 %!assert(issorted (fliplr (sv), "descending"));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5902 %!assert(!issorted (sv', "descending"));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5903 %!assert(issorted (fliplr (sv)', "descending"));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5904 %!assert(!issorted (um, "rows", "either"));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5905 %!assert(!issorted (uv, "either"));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5906 %!assert(issorted (sm, "rows", "either"));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5907 %!assert(issorted (flipud (sm), "rows", "either"));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5908 %!assert(issorted (sv, "either"));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5909 %!assert(issorted (fliplr (sv), "either"));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5910 %!assert(issorted (sv', "either"));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5911 %!assert(issorted (fliplr (sv)', "either"));
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5912 */
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	5913
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5914 DEFUN (nth_element, args, ,
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5915 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	5916 @deftypefn {Built-in Function} {} nth_element (@var{x}, @var{n})\n\
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5917 @deftypefnx {Built-in Function} {} nth_element (@var{x}, @var{n}, @var{dim})\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	5918 Select the n-th smallest element of a vector, using the ordering defined by\n\
89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	5919 @code{sort}. In other words, the result is equivalent to\n\
89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	5920 @code{sort(@var{x})(@var{n})}.\n\
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5921 @var{n} can also be a contiguous range, either ascending @code{l:u}\n\
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5922 or descending @code{u:-1:l}, in which case a range of elements is returned.\n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	5923 If @var{x} is an array, @code{nth_element} operates along the dimension\n\
a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	5924 defined by @var{dim}, or the first non-singleton dimension if @var{dim} is\n\
a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	5925 not given.\n\
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5926 \n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	5927 nth_element encapsulates the C++ standard library algorithms nth_element and\n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	5928 partial_sort. On average, the complexity of the operation is O(M*log(K)),\n\
a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	5929 where @code{M = size(@var{x}, @var{dim})} and @code{K = length (@var{n})}.\n\
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5930 This function is intended for cases where the ratio K/M is small; otherwise,\n\
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5931 it may be better to use @code{sort}.\n\
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5932 @seealso{sort, min, max}\n\
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5933 @end deftypefn")
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5934 {
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5935 octave_value retval;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5936 int nargin = args.length ();
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5937
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5938 if (nargin == 2 \|\| nargin == 3)
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5939 {
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5940 octave_value argx = args(0);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5941
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5942 int dim = -1;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5943 if (nargin == 3)
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5944 {
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5945 dim = args(2).int_value (true) - 1;
10703 5eb420d92307 fix sort and nth_element when trailing singleton dim is specified Jaroslav Hajek <highegg@gmail.com> parents: 10695 diff changeset	5946 if (dim < 0)
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	5947 error ("nth_element: DIM must be a valid dimension");
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5948 }
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5949 if (dim < 0)
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5950 dim = argx.dims ().first_non_singleton ();
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5951
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5952 idx_vector n = args(1).index_vector ();
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5953
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5954 if (error_state)
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5955 return retval;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5956
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5957 switch (argx.builtin_type ())
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5958 {
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5959 case btyp_double:
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5960 retval = argx.array_value ().nth_element (n, dim);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5961 break;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5962 case btyp_float:
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5963 retval = argx.float_array_value ().nth_element (n, dim);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5964 break;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5965 case btyp_complex:
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5966 retval = argx.complex_array_value ().nth_element (n, dim);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5967 break;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5968 case btyp_float_complex:
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5969 retval = argx.float_complex_array_value ().nth_element (n, dim);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5970 break;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5971 #define MAKE_INT_BRANCH(X) \
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5972 case btyp_ ## X: \
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5973 retval = argx.X ## _array_value ().nth_element (n, dim); \
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5974 break
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5975
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5976 MAKE_INT_BRANCH (int8);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5977 MAKE_INT_BRANCH (int16);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5978 MAKE_INT_BRANCH (int32);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5979 MAKE_INT_BRANCH (int64);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5980 MAKE_INT_BRANCH (uint8);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5981 MAKE_INT_BRANCH (uint16);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5982 MAKE_INT_BRANCH (uint32);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5983 MAKE_INT_BRANCH (uint64);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5984 #undef MAKE_INT_BRANCH
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5985 default:
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5986 if (argx.is_cellstr ())
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5987 retval = argx.cellstr_value ().nth_element (n, dim);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5988 else
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5989 gripe_wrong_type_arg ("nth_element", argx);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5990 }
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5991 }
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5992 else
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5993 print_usage ();
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5994
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5995 return retval;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5996 }
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	5997
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	5998 template <class NDT>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	5999 static NDT
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6000 do_accumarray_sum (const idx_vector& idx, const NDT& vals,
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6001 octave_idx_type n = -1)
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6002 {
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6003 typedef typename NDT::element_type T;
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6004 if (n < 0)
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6005 n = idx.extent (0);
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6006 else if (idx.extent (n) > n)
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6007 error ("accumarray: index out of range");
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6008
9858 47c5af1868df move idx_add methods to MArrayN Jaroslav Hajek <highegg@gmail.com> parents: 9856 diff changeset	6009 NDT retval (dim_vector (n, 1), T());
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6010
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6011 if (vals.numel () == 1)
9858 47c5af1868df move idx_add methods to MArrayN Jaroslav Hajek <highegg@gmail.com> parents: 9856 diff changeset	6012 retval.idx_add (idx, vals (0));
47c5af1868df move idx_add methods to MArrayN Jaroslav Hajek <highegg@gmail.com> parents: 9856 diff changeset	6013 else if (vals.numel () == idx.length (n))
47c5af1868df move idx_add methods to MArrayN Jaroslav Hajek <highegg@gmail.com> parents: 9856 diff changeset	6014 retval.idx_add (idx, vals);
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6015 else
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6016 error ("accumarray: dimensions mismatch");
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6017
9858 47c5af1868df move idx_add methods to MArrayN Jaroslav Hajek <highegg@gmail.com> parents: 9856 diff changeset	6018 return retval;
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6019 }
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6020
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6021 DEFUN (__accumarray_sum__, args, ,
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6022 "-- texinfo --\n\
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6023 @deftypefn {Built-in Function} {} __accumarray_sum__ (@var{idx}, @var{vals}, @var{n})\n\
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6024 Undocumented internal function.\n\
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6025 @end deftypefn")
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6026 {
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6027 octave_value retval;
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6028 int nargin = args.length ();
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6029 if (nargin >= 2 && nargin <= 3 && args(0).is_numeric_type ())
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6030 {
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6031 idx_vector idx = args(0).index_vector ();
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6032 octave_idx_type n = -1;
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6033 if (nargin == 3)
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6034 n = args(2).idx_type_value (true);
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6035
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6036 if (! error_state)
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6037 {
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6038 octave_value vals = args(1);
9198 3b9aacf07744 optimize accumarray with constant ranges Jaroslav Hajek <highegg@gmail.com> parents: 9197 diff changeset	6039 if (vals.is_range ())
3b9aacf07744 optimize accumarray with constant ranges Jaroslav Hajek <highegg@gmail.com> parents: 9197 diff changeset	6040 {
3b9aacf07744 optimize accumarray with constant ranges Jaroslav Hajek <highegg@gmail.com> parents: 9197 diff changeset	6041 Range r = vals.range_value ();
3b9aacf07744 optimize accumarray with constant ranges Jaroslav Hajek <highegg@gmail.com> parents: 9197 diff changeset	6042 if (r.inc () == 0)
3b9aacf07744 optimize accumarray with constant ranges Jaroslav Hajek <highegg@gmail.com> parents: 9197 diff changeset	6043 vals = r.base ();
3b9aacf07744 optimize accumarray with constant ranges Jaroslav Hajek <highegg@gmail.com> parents: 9197 diff changeset	6044 }
3b9aacf07744 optimize accumarray with constant ranges Jaroslav Hajek <highegg@gmail.com> parents: 9197 diff changeset	6045
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6046 if (vals.is_single_type ())
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6047 {
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6048 if (vals.is_complex_type ())
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6049 retval = do_accumarray_sum (idx, vals.float_complex_array_value (), n);
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6050 else
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6051 retval = do_accumarray_sum (idx, vals.float_array_value (), n);
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6052 }
10269 217d36560dfa small fixes to accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10268 diff changeset	6053 else if (vals.is_numeric_type () \|\| vals.is_bool_type ())
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6054 {
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6055 if (vals.is_complex_type ())
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6056 retval = do_accumarray_sum (idx, vals.complex_array_value (), n);
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6057 else
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6058 retval = do_accumarray_sum (idx, vals.array_value (), n);
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6059 }
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6060 else
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6061 gripe_wrong_type_arg ("accumarray", vals);
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6062 }
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6063 }
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6064 else
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6065 print_usage ();
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6066
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	6067 return retval;
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	6068 }
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	6069
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6070 template <class NDT>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	6071 static NDT
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6072 do_accumarray_minmax (const idx_vector& idx, const NDT& vals,
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6073 octave_idx_type n, bool ismin,
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6074 const typename NDT::element_type& zero_val)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6075 {
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6076 typedef typename NDT::element_type T;
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6077 if (n < 0)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6078 n = idx.extent (0);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6079 else if (idx.extent (n) > n)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6080 error ("accumarray: index out of range");
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6081
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6082 NDT retval (dim_vector (n, 1), zero_val);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6083
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6084 // Pick minimizer or maximizer.
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	6085 void (MArray<T>::*op) (const idx_vector&, const MArray<T>&) =
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10315 diff changeset	6086 ismin ? (&MArray<T>::idx_min) : (&MArray<T>::idx_max);
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6087
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6088 octave_idx_type l = idx.length (n);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6089 if (vals.numel () == 1)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6090 (retval.*op) (idx, NDT (dim_vector (l, 1), vals(0)));
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6091 else if (vals.numel () == l)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6092 (retval.*op) (idx, vals);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6093 else
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6094 error ("accumarray: dimensions mismatch");
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6095
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6096 return retval;
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6097 }
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6098
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6099 static octave_value_list
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6100 do_accumarray_minmax_fun (const octave_value_list& args,
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6101 bool ismin)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6102 {
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6103 octave_value retval;
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6104 int nargin = args.length ();
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6105 if (nargin >= 3 && nargin <= 4 && args(0).is_numeric_type ())
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6106 {
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6107 idx_vector idx = args(0).index_vector ();
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6108 octave_idx_type n = -1;
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6109 if (nargin == 4)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6110 n = args(3).idx_type_value (true);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6111
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6112 if (! error_state)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6113 {
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6114 octave_value vals = args(1), zero = args (2);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6115
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6116 switch (vals.builtin_type ())
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6117 {
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6118 case btyp_double:
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6119 retval = do_accumarray_minmax (idx, vals.array_value (), n, ismin,
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6120 zero.double_value ());
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6121 break;
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6122 case btyp_float:
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6123 retval = do_accumarray_minmax (idx, vals.float_array_value (), n, ismin,
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6124 zero.float_value ());
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6125 break;
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6126 case btyp_complex:
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6127 retval = do_accumarray_minmax (idx, vals.complex_array_value (), n, ismin,
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6128 zero.complex_value ());
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6129 break;
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6130 case btyp_float_complex:
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6131 retval = do_accumarray_minmax (idx, vals.float_complex_array_value (), n, ismin,
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6132 zero.float_complex_value ());
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6133 break;
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6134 #define MAKE_INT_BRANCH(X) \
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6135 case btyp_ ## X: \
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6136 retval = do_accumarray_minmax (idx, vals.X ## _array_value (), n, ismin, \
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6137 zero.X ## _scalar_value ()); \
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6138 break
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6139
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6140 MAKE_INT_BRANCH (int8);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6141 MAKE_INT_BRANCH (int16);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6142 MAKE_INT_BRANCH (int32);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6143 MAKE_INT_BRANCH (int64);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6144 MAKE_INT_BRANCH (uint8);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6145 MAKE_INT_BRANCH (uint16);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6146 MAKE_INT_BRANCH (uint32);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6147 MAKE_INT_BRANCH (uint64);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6148 #undef MAKE_INT_BRANCH
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6149 case btyp_bool:
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6150 retval = do_accumarray_minmax (idx, vals.array_value (), n, ismin,
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6151 zero.bool_value ());
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6152 break;
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6153 default:
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6154 gripe_wrong_type_arg ("accumarray", vals);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6155 }
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6156 }
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6157 }
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6158 else
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6159 print_usage ();
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6160
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	6161 return retval;
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6162 }
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6163
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6164 DEFUN (__accumarray_min__, args, ,
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6165 "-- texinfo --\n\
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6166 @deftypefn {Built-in Function} {} __accumarray_min__ (@var{idx}, @var{vals}, @var{zero}, @var{n})\n\
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6167 Undocumented internal function.\n\
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6168 @end deftypefn")
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6169 {
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6170 return do_accumarray_minmax_fun (args, true);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6171 }
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6172
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6173 DEFUN (__accumarray_max__, args, ,
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6174 "-- texinfo --\n\
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6175 @deftypefn {Built-in Function} {} __accumarray_max__ (@var{idx}, @var{vals}, @var{zero}, @var{n})\n\
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6176 Undocumented internal function.\n\
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6177 @end deftypefn")
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6178 {
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6179 return do_accumarray_minmax_fun (args, false);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6180 }
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6181
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	6182 template <class NDT>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	6183 static NDT
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6184 do_accumdim_sum (const idx_vector& idx, const NDT& vals,
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6185 int dim = -1, octave_idx_type n = -1)
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6186 {
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6187 typedef typename NDT::element_type T;
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6188 if (n < 0)
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6189 n = idx.extent (0);
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6190 else if (idx.extent (n) > n)
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6191 error ("accumarray: index out of range");
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6192
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6193 dim_vector rdv = vals.dims ();
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6194 if (dim < 0)
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6195 dim = vals.dims ().first_non_singleton ();
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6196 else if (dim >= rdv.length ())
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6197 rdv.resize (dim+1, 1);
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6198
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6199 rdv(dim) = n;
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6200
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6201 NDT retval (rdv, T());
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6202
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6203 retval.idx_add_nd (idx, vals, dim);
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6204 return retval;
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6205 }
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6206
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6207 DEFUN (__accumdim_sum__, args, ,
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6208 "-- texinfo --\n\
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6209 @deftypefn {Built-in Function} {} __accumdim_sum__ (@var{idx}, @var{vals}, @var{dim}, @var{n})\n\
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6210 Undocumented internal function.\n\
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6211 @end deftypefn")
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6212 {
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6213 octave_value retval;
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6214 int nargin = args.length ();
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6215 if (nargin >= 2 && nargin <= 4 && args(0).is_numeric_type ())
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6216 {
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6217 idx_vector idx = args(0).index_vector ();
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6218 int dim = -1;
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6219 if (nargin >= 3)
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6220 dim = args(2).int_value () - 1;
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6221
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6222 octave_idx_type n = -1;
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6223 if (nargin == 4)
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6224 n = args(3).idx_type_value (true);
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6225
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6226 if (! error_state)
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6227 {
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6228 octave_value vals = args(1);
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6229
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6230 if (vals.is_single_type ())
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6231 {
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6232 if (vals.is_complex_type ())
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6233 retval = do_accumdim_sum (idx, vals.float_complex_array_value (), dim, n);
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6234 else
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6235 retval = do_accumdim_sum (idx, vals.float_array_value (), dim, n);
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6236 }
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6237 else if (vals.is_numeric_type () \|\| vals.is_bool_type ())
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6238 {
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6239 if (vals.is_complex_type ())
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6240 retval = do_accumdim_sum (idx, vals.complex_array_value (), dim, n);
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6241 else
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6242 retval = do_accumdim_sum (idx, vals.array_value (), dim, n);
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6243 }
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6244 else
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6245 gripe_wrong_type_arg ("accumdim", vals);
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6246 }
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6247 }
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6248 else
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6249 print_usage ();
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6250
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	6251 return retval;
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6252 }
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6253
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	6254 template <class NDT>
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6255 static NDT
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6256 do_merge (const Array<bool>& mask,
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6257 const NDT& tval, const NDT& fval)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6258 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6259 typedef typename NDT::element_type T;
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6260 dim_vector dv = mask.dims ();
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6261 NDT retval (dv);
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6262
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6263 bool tscl = tval.numel () == 1, fscl = fval.numel () == 1;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	6264
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6265 if ((! tscl && tval.dims () != dv)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6266 \|\| (! 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	6267 error ("merge: MASK, TVAL, and FVAL dimensions must match");
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6268 else
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6269 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6270 T *rv = retval.fortran_vec ();
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6271 octave_idx_type n = retval.numel ();
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6272
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6273 const T tv = tval.data (), fv = fval.data ();
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6274 const bool *mv = mask.data ();
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6275
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6276 if (tscl)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6277 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6278 if (fscl)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6279 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6280 T ts = tv[0], fs = fv[0];
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6281 for (octave_idx_type i = 0; i < n; i++)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6282 rv[i] = mv[i] ? ts : fs;
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6283 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6284 else
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6285 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6286 T ts = tv[0];
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6287 for (octave_idx_type i = 0; i < n; i++)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6288 rv[i] = mv[i] ? ts : fv[i];
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6289 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6290 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6291 else
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6292 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6293 if (fscl)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6294 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6295 T fs = fv[0];
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6296 for (octave_idx_type i = 0; i < n; i++)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6297 rv[i] = mv[i] ? tv[i] : fs;
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6298 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6299 else
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6300 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6301 for (octave_idx_type i = 0; i < n; i++)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6302 rv[i] = mv[i] ? tv[i] : fv[i];
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6303 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6304 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6305 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6306
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6307 return retval;
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6308 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6309
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6310 #define MAKE_INT_BRANCH(INTX) \
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6311 else if (tval.is_ ## INTX ## _type () && fval.is_ ## INTX ## _type ()) \
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6312 { \
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6313 retval = do_merge (mask, \
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6314 tval.INTX ## _array_value (), \
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6315 fval.INTX ## _array_value ()); \
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6316 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6317
9505 a321a1c227c8 make ifelse an alias or merge Jaroslav Hajek <highegg@gmail.com> parents: 9475 diff changeset	6318 DEFUN (merge, args, ,
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6319 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	6320 @deftypefn {Built-in Function} {} merge (@var{mask}, @var{tval}, @var{fval})\n\
9505 a321a1c227c8 make ifelse an alias or merge Jaroslav Hajek <highegg@gmail.com> parents: 9475 diff changeset	6321 @deftypefnx {Built-in Function} {} ifelse (@var{mask}, @var{tval}, @var{fval})\n\
11572 7d6d8c1e471f Grammarcheck Texinfo for files in src directory. Rik <octave@nomad.inbox5.com> parents: 11570 diff changeset	6322 Merge elements of @var{true_val} and @var{false_val}, depending on the\n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	6323 value of @var{mask}. If @var{mask} is a logical scalar, the other two\n\
a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	6324 arguments can be arbitrary values. Otherwise, @var{mask} must be a logical\n\
a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	6325 array, and @var{tval}, @var{fval} should be arrays of matching class, or\n\
a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	6326 cell arrays. In the scalar mask case, @var{tval} is returned if @var{mask}\n\
a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	6327 is true, otherwise @var{fval} is returned.\n\
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6328 \n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	6329 In the array mask case, both @var{tval} and @var{fval} must be either\n\
a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	6330 scalars or arrays with dimensions equal to @var{mask}. The result is\n\
a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	6331 constructed as follows: \n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	6332 \n\
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6333 @example\n\
9758 09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format Rik <rdrider0-list@yahoo.com> parents: 9736 diff changeset	6334 @group\n\
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6335 result(mask) = tval(mask);\n\
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6336 result(! mask) = fval(! mask);\n\
9758 09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format Rik <rdrider0-list@yahoo.com> parents: 9736 diff changeset	6337 @end group\n\
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6338 @end example\n\
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6339 \n\
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6340 @var{mask} can also be arbitrary numeric type, in which case\n\
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6341 it is first converted to logical.\n\
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6342 @seealso{logical}\n\
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6343 @end deftypefn")
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6344 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6345 int nargin = args.length ();
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6346 octave_value retval;
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6347
9856 870a69bac55c fix test in merge Jaroslav Hajek <highegg@gmail.com> parents: 9848 diff changeset	6348 if (nargin == 3 && (args(0).is_bool_type () \|\| args(0).is_numeric_type ()))
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6349 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6350 octave_value mask_val = args(0);
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6351
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6352 if (mask_val.is_scalar_type ())
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6353 retval = mask_val.is_true () ? args(1) : args(2);
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6354 else
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6355 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6356 boolNDArray mask = mask_val.bool_array_value ();
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6357 octave_value tval = args(1), fval = args(2);
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6358 if (tval.is_double_type () && fval.is_double_type ())
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6359 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6360 if (tval.is_complex_type () \|\| fval.is_complex_type ())
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6361 retval = do_merge (mask,
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6362 tval.complex_array_value (),
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6363 fval.complex_array_value ());
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6364 else
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6365 retval = do_merge (mask,
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6366 tval.array_value (),
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6367 fval.array_value ());
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6368 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6369 else if (tval.is_single_type () && fval.is_single_type ())
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6370 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6371 if (tval.is_complex_type () \|\| fval.is_complex_type ())
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6372 retval = do_merge (mask,
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6373 tval.float_complex_array_value (),
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6374 fval.float_complex_array_value ());
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6375 else
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6376 retval = do_merge (mask,
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6377 tval.float_array_value (),
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6378 fval.float_array_value ());
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6379 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6380 else if (tval.is_string () && fval.is_string ())
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6381 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6382 bool sq_string = tval.is_sq_string () \|\| fval.is_sq_string ();
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6383 retval = octave_value (do_merge (mask,
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6384 tval.char_array_value (),
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6385 fval.char_array_value ()),
9689 34d6f005db4b eliminate is_string argument from octave_value character array constructors John W. Eaton <jwe@octave.org> parents: 9685 diff changeset	6386 sq_string ? '\'' : '"');
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6387 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6388 else if (tval.is_cell () && fval.is_cell ())
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6389 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6390 retval = do_merge (mask,
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6391 tval.cell_value (),
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6392 fval.cell_value ());
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6393 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6394
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6395 MAKE_INT_BRANCH (int8)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6396 MAKE_INT_BRANCH (int16)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6397 MAKE_INT_BRANCH (int32)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6398 MAKE_INT_BRANCH (int64)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6399 MAKE_INT_BRANCH (uint8)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6400 MAKE_INT_BRANCH (uint16)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6401 MAKE_INT_BRANCH (uint32)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6402 MAKE_INT_BRANCH (uint64)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6403
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6404 else
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	6405 error ("merge: cannot merge %s with %s with array mask",
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6406 tval.class_name ().c_str (),
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6407 fval.class_name ().c_str ());
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6408 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6409 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6410 else
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6411 print_usage ();
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6412
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6413 return retval;
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6414 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6415
9505 a321a1c227c8 make ifelse an alias or merge Jaroslav Hajek <highegg@gmail.com> parents: 9475 diff changeset	6416 DEFALIAS (ifelse, merge);
a321a1c227c8 make ifelse an alias or merge Jaroslav Hajek <highegg@gmail.com> parents: 9475 diff changeset	6417
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	6418 #undef MAKE_INT_BRANCH
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	6419
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6420 template <class SparseT>
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6421 static SparseT
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6422 do_sparse_diff (const SparseT& array, octave_idx_type order,
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6423 int dim)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6424 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6425 SparseT retval = array;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6426 if (dim == 1)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6427 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6428 octave_idx_type k = retval.columns ();
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6429 while (order > 0 && k > 0)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6430 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6431 idx_vector col1 (':'), col2 (':'), sl1 (1, k), sl2 (0, k-1);
10785 c2041adcf234 remove unnecessary sparse indexing overloads Jaroslav Hajek <highegg@gmail.com> parents: 10763 diff changeset	6432 retval = SparseT (retval.index (col1, sl1)) - SparseT (retval.index (col2, sl2));
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6433 assert (retval.columns () == k-1);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6434 order--;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6435 k--;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6436 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6437 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6438 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6439 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6440 octave_idx_type k = retval.rows ();
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6441 while (order > 0 && k > 0)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6442 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6443 idx_vector col1 (':'), col2 (':'), sl1 (1, k), sl2 (0, k-1);
10785 c2041adcf234 remove unnecessary sparse indexing overloads Jaroslav Hajek <highegg@gmail.com> parents: 10763 diff changeset	6444 retval = SparseT (retval.index (sl1, col1)) - SparseT (retval.index (sl2, col2));
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6445 assert (retval.rows () == k-1);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6446 order--;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6447 k--;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6448 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6449 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6450
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6451 return retval;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6452 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6453
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6454 static octave_value
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6455 do_diff (const octave_value& array, octave_idx_type order,
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6456 int dim = -1)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6457 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6458 octave_value retval;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6459
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6460 const dim_vector& dv = array.dims ();
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6461 if (dim == -1)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6462 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6463 dim = array.dims ().first_non_singleton ();
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6464
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6465 // Bother Matlab. This behavior is really wicked.
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6466 if (dv(dim) <= order)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6467 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6468 if (dv(dim) == 1)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6469 retval = array.resize (dim_vector (0, 0));
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6470 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6471 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6472 retval = array;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6473 while (order > 0)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6474 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6475 if (dim == dv.length ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6476 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6477 retval = do_diff (array, order, dim - 1);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6478 order = 0;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6479 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6480 else if (dv(dim) == 1)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6481 dim++;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6482 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6483 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6484 retval = do_diff (array, dv(dim) - 1, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6485 order -= dv(dim) - 1;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6486 dim++;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6487 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6488 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6489 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6490
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6491 return retval;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6492 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6493 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6494
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6495 if (array.is_integer_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6496 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6497 if (array.is_int8_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6498 retval = array.int8_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6499 else if (array.is_int16_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6500 retval = array.int16_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6501 else if (array.is_int32_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6502 retval = array.int32_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6503 else if (array.is_int64_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6504 retval = array.int64_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6505 else if (array.is_uint8_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6506 retval = array.uint8_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6507 else if (array.is_uint16_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6508 retval = array.uint16_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6509 else if (array.is_uint32_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6510 retval = array.uint32_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6511 else if (array.is_uint64_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6512 retval = array.uint64_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6513 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6514 panic_impossible ();
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6515 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6516 else if (array.is_sparse_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6517 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6518 if (array.is_complex_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6519 retval = do_sparse_diff (array.sparse_complex_matrix_value (), order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6520 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6521 retval = do_sparse_diff (array.sparse_matrix_value (), order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6522 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6523 else if (array.is_single_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6524 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6525 if (array.is_complex_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6526 retval = array.float_complex_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6527 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6528 retval = array.float_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6529 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6530 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6531 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6532 if (array.is_complex_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6533 retval = array.complex_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6534 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6535 retval = array.array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6536 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6537
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6538 return retval;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6539 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6540
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6541 DEFUN (diff, args, ,
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6542 "-- texinfo --\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6543 @deftypefn {Built-in Function} {} diff (@var{x}, @var{k}, @var{dim})\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6544 If @var{x} is a vector of length @var{n}, @code{diff (@var{x})} is the\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6545 vector of first differences\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6546 @tex\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6547 $x_2 - x_1, \\ldots{}, x_n - x_{n-1}$.\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6548 @end tex\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6549 @ifnottex\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6550 @var{x}(2) - @var{x}(1), @dots{}, @var{x}(n) - @var{x}(n-1).\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6551 @end ifnottex\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6552 \n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6553 If @var{x} is a matrix, @code{diff (@var{x})} is the matrix of column\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6554 differences along the first non-singleton dimension.\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6555 \n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6556 The second argument is optional. If supplied, @code{diff (@var{x},\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6557 @var{k})}, where @var{k} is a non-negative integer, returns the\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6558 @var{k}-th differences. It is possible that @var{k} is larger than\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6559 then first non-singleton dimension of the matrix. In this case,\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6560 @code{diff} continues to take the differences along the next\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6561 non-singleton dimension.\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6562 \n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6563 The dimension along which to take the difference can be explicitly\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6564 stated with the optional variable @var{dim}. In this case the \n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6565 @var{k}-th order differences are calculated along this dimension.\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6566 In the case where @var{k} exceeds @code{size (@var{x}, @var{dim})}\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6567 then an empty matrix is returned.\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6568 @end deftypefn")
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6569 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6570 int nargin = args.length ();
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6571 octave_value retval;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6572
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6573 if (nargin < 1 \|\| nargin > 3)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6574 print_usage ();
10880 92c3e8068f28 allow diff(logical) Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	6575 else if (! (args(0).is_numeric_type () \|\| args(0).is_bool_type ()))
92c3e8068f28 allow diff(logical) Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	6576 error ("diff: X must be numeric or logical");
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6577
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6578 if (! error_state)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6579 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6580 int dim = -1;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6581 octave_idx_type order = 1;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6582 if (nargin > 1)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6583 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6584 if (args(1).is_scalar_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6585 order = args(1).idx_type_value (true, false);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6586 else if (! args(1).is_zero_by_zero ())
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	6587 error ("order K must be a scalar or []");
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6588 if (! error_state && order < 0)
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	6589 error ("order K must be non-negative");
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6590 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6591
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6592 if (nargin > 2)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6593 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6594 dim = args(2).int_value (true, false);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6595 if (! error_state && (dim < 1 \|\| dim > args(0).ndims ()))
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	6596 error ("DIM must be a valid dimension");
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6597 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6598 dim -= 1;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6599 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6600
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6601 if (! error_state)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6602 retval = do_diff (args(0), order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6603 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6604
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6605 return retval;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6606 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6607
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6608 /*
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6609
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6610 %!assert (diff ([1, 2, 3, 4]), [1, 1, 1])
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6611 %!assert (diff ([1, 3, 7, 19], 2), [2, 8])
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6612 %!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	6613 %!assert (diff ([1, 2; 5, 4; 8, 7; 9, 6; 3, 1], 3), [-1, -5; -5, 0])
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6614 %!assert (isempty (diff (1)));
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6615
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6616 %!error diff ([1, 2; 3, 4], -1);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6617
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6618 %!error diff ("foo");
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6619
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6620 %!error diff ();
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6621
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6622 %!error diff (1, 2, 3, 4);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6623
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	6624 */
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6625
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6626 template <class T>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	6627 static Array<T>
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6628 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	6629 {
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6630 Array<T> retval;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6631
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6632 assert (rep.ndims () == 2 && rep.rows () == 2);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6633
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6634 octave_idx_type n = rep.columns (), l = 0;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6635 for (octave_idx_type i = 0; i < n; i++)
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6636 {
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6637 octave_idx_type k = rep(1, i);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6638 if (k < 0)
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6639 {
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	6640 error ("repelems: second row must contain non-negative numbers");
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6641 return retval;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6642 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6643
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6644 l += k;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6645 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6646
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6647 retval.clear (1, l);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6648 T *dest = retval.fortran_vec ();
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6649 l = 0;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6650 for (octave_idx_type i = 0; i < n; i++)
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6651 {
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6652 octave_idx_type k = rep(1, i);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6653 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	6654 dest += k;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6655 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6656
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6657 return retval;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6658 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6659
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6660 DEFUN (repelems, args, ,
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6661 "-- texinfo --\n\
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6662 @deftypefn {Built-in Function} {} repelems (@var{x}, @var{r})\n\
10801 a40e32927b3a Improve documentation for new repelems function. Rik <octave@nomad.inbox5.com> parents: 10799 diff changeset	6663 Construct a vector of repeated elements from @var{x}. @var{r}\n\
a40e32927b3a Improve documentation for new repelems function. Rik <octave@nomad.inbox5.com> parents: 10799 diff changeset	6664 is a 2x@var{N} integer matrix specifying which elements to repeat and\n\
a40e32927b3a Improve documentation for new repelems function. Rik <octave@nomad.inbox5.com> parents: 10799 diff changeset	6665 how often to repeat each element.\n\
a40e32927b3a Improve documentation for new repelems function. Rik <octave@nomad.inbox5.com> parents: 10799 diff changeset	6666 \n\
a40e32927b3a Improve documentation for new repelems function. Rik <octave@nomad.inbox5.com> parents: 10799 diff changeset	6667 Entries in the first row, @var{r}(1,j), select an element to repeat.\n\
a40e32927b3a Improve documentation for new repelems function. Rik <octave@nomad.inbox5.com> parents: 10799 diff changeset	6668 The corresponding entry in the second row, @var{r}(2,j), specifies\n\
a40e32927b3a Improve documentation for new repelems function. Rik <octave@nomad.inbox5.com> parents: 10799 diff changeset	6669 the repeat count. If @var{x} is a matrix then the columns of @var{x} are\n\
a40e32927b3a Improve documentation for new repelems function. Rik <octave@nomad.inbox5.com> parents: 10799 diff changeset	6670 imagined to be stacked on top of each other for purposes of the selection\n\
a40e32927b3a Improve documentation for new repelems function. Rik <octave@nomad.inbox5.com> parents: 10799 diff changeset	6671 index. A row vector is always returned.\n\
a40e32927b3a Improve documentation for new repelems function. Rik <octave@nomad.inbox5.com> parents: 10799 diff changeset	6672 \n\
a40e32927b3a Improve documentation for new repelems function. Rik <octave@nomad.inbox5.com> parents: 10799 diff changeset	6673 Conceptually the result is calculated as follows:\n\
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6674 \n\
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6675 @example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	6676 @group\n\
10801 a40e32927b3a Improve documentation for new repelems function. Rik <octave@nomad.inbox5.com> parents: 10799 diff changeset	6677 y = [];\n\
a40e32927b3a Improve documentation for new repelems function. Rik <octave@nomad.inbox5.com> parents: 10799 diff changeset	6678 for i = 1:columns (@var{r})\n\
a40e32927b3a Improve documentation for new repelems function. Rik <octave@nomad.inbox5.com> parents: 10799 diff changeset	6679 y = [y, @var{x}(@var{r}(1,i)*ones(1, @var{r}(2,i)))];\n\
a40e32927b3a Improve documentation for new repelems function. Rik <octave@nomad.inbox5.com> parents: 10799 diff changeset	6680 endfor\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	6681 @end group\n\
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6682 @end example\n\
10801 a40e32927b3a Improve documentation for new repelems function. Rik <octave@nomad.inbox5.com> parents: 10799 diff changeset	6683 @seealso{repmat}\n\
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6684 @end deftypefn")
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6685 {
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6686 octave_value retval;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6687
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6688 if (args.length () == 2)
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6689 {
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6690 octave_value x = args(0);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6691
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6692 const Matrix rm = args(1).matrix_value ();
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6693 if (error_state)
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6694 return retval;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6695 else if (rm.rows () != 2 \|\| rm.ndims () != 2)
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6696 {
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	6697 error ("repelems: R must be a matrix with two rows");
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6698 return retval;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6699 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6700 else
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6701 {
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6702 NoAlias< Array<octave_idx_type> > r (rm.dims ());
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6703
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6704 for (octave_idx_type i = 0; i < rm.numel (); i++)
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6705 {
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6706 octave_idx_type rx = rm(i);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6707 if (static_cast<double> (rx) != rm(i))
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6708 {
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	6709 error ("repelems: R must be a matrix of integers");
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6710 return retval;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6711 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6712
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6713 r(i) = rx;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6714 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6715
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6716 switch (x.builtin_type ())
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6717 {
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6718 #define BTYP_BRANCH(X, EX) \
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6719 case btyp_ ## X: \
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6720 retval = do_repelems (x.EX ## _value (), r); \
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6721 break
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6722
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6723 BTYP_BRANCH (double, array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6724 BTYP_BRANCH (float, float_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6725 BTYP_BRANCH (complex, complex_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6726 BTYP_BRANCH (float_complex, float_complex_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6727 BTYP_BRANCH (bool, bool_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6728 BTYP_BRANCH (char, char_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6729
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6730 BTYP_BRANCH (int8, int8_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6731 BTYP_BRANCH (int16, int16_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6732 BTYP_BRANCH (int32, int32_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6733 BTYP_BRANCH (int64, int64_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6734 BTYP_BRANCH (uint8, uint8_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6735 BTYP_BRANCH (uint16, uint16_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6736 BTYP_BRANCH (uint32, uint32_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6737 BTYP_BRANCH (uint64, uint64_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6738
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6739 BTYP_BRANCH (cell, cell);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6740 //BTYP_BRANCH (struct, map);//FIXME
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6741 #undef BTYP_BRANCH
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6742
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6743 default:
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6744 gripe_wrong_type_arg ("repelems", x);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6745 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6746 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6747 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6748 else
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6749 print_usage ();
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6750
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6751 return retval;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	6752 }

Mercurial > hg > octave-avbm

annotate src/data.cc @ 12570:1a93988610a3