octave-nkf: libinterp/corefcn/data.cc annotate

annotate libinterp/corefcn/data.cc @ 20501:16b9ec39ff46

Return empty matrix when linspace called with 0 points (bug #45820) * NEWS: Announce change. * data.cc (Flinspace): Verify input N is scalar. Verify inputs BASE, LIMIT are scalar/vectors. Add BIST tests for input validation, complex values, class of output, Matlab compatibility. Clarify documentation about vector inputs. * CMatrix.cc, CRowVector.cc, dMatrix.cc, dRowVector.cc, fCMatrix.cc, fCRowVector.cc, fMatrix.cc, fRowVector.cc: Return empty matrix when N < 1.

author	Rik <rik@octave.org>
date	Thu, 27 Aug 2015 13:12:21 -0700
parents	e3f84a8c6788
children	4bb41929286b

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
19731 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19631 diff changeset	3 Copyright (C) 1994-2015 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
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	6 Copyright (C) 2012 Carlo de Falco
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	7
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	8 This file is part of Octave.
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	9
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	10 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	11 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	12 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	13 option) any later version.
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	14
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	15 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	16 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	17 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	18 for more details.
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	19
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	20 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	21 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	22 <http://www.gnu.org/licenses/>.
523 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
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	26 #ifdef HAVE_CONFIG_H
1192 b6360f2d4fa6 [project @ 1995-03-30 21:38:35 by jwe] jwe parents: 1129 diff changeset	27 #include <config.h>
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	28 #endif
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	29
7078 405cf85b435c [project @ 2007-10-30 14:04:59 by jwe] jwe parents: 7065 diff changeset	30 #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	31 #include <sys/times.h>
7078 405cf85b435c [project @ 2007-10-30 14:04:59 by jwe] jwe parents: 7065 diff changeset	32
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe] jwe parents: 7065 diff changeset	33 #ifdef HAVE_SYS_RESOURCE_H
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe] jwe parents: 7065 diff changeset	34 #include <sys/resource.h>
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe] jwe parents: 7065 diff changeset	35 #endif
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe] jwe parents: 7065 diff changeset	36
2184 dbbbb3559ee8 [project @ 1996-05-14 02:18:22 by jwe] jwe parents: 2086 diff changeset	37 #include <cfloat>
10303 e4899d6320b6 data.cc: use CLOCKS_PER_SEC instead of HZ John W. Eaton <jwe@octave.org> parents: 10302 diff changeset	38 #include <ctime>
2184 dbbbb3559ee8 [project @ 1996-05-14 02:18:22 by jwe] jwe parents: 2086 diff changeset	39
1728 42b4f904f1af [project @ 1996-01-09 11:36:01 by jwe] jwe parents: 1572 diff changeset	40 #include <string>
42b4f904f1af [project @ 1996-01-09 11:36:01 by jwe] jwe parents: 1572 diff changeset	41
2184 dbbbb3559ee8 [project @ 1996-05-14 02:18:22 by jwe] jwe parents: 2086 diff changeset	42 #include "lo-ieee.h"
7231 2eb392d058bb [project @ 2007-11-30 18:53:29 by jwe] jwe parents: 7189 diff changeset	43 #include "lo-math.h"
15252 fa0118cb67d9 move base64 encode and decode functionality to liboctave John W. Eaton <jwe@octave.org> parents: 15213 diff changeset	44 #include "oct-base64.h"
10240 fa7b5751730c use gnulib time, sys_time, and sys_times modules John W. Eaton <jwe@octave.org> parents: 10185 diff changeset	45 #include "oct-time.h"
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1742 diff changeset	46 #include "str-vec.h"
4153 6b96ce9f5743 [project @ 2002-11-06 20:38:49 by jwe] jwe parents: 4114 diff changeset	47 #include "quit.h"
9658 3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	48 #include "mx-base.h"
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	49 #include "oct-binmap.h"
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1742 diff changeset	50
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	51 #include "Cell.h"
1352 19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1315 diff changeset	52 #include "defun.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1315 diff changeset	53 #include "error.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1315 diff changeset	54 #include "gripes.h"
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	55 #include "oct-map.h"
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	56 #include "oct-obj.h"
2366 c90105b99479 [project @ 1996-10-11 23:22:27 by jwe] jwe parents: 2305 diff changeset	57 #include "ov.h"
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	58 #include "ov-class.h"
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	59 #include "ov-float.h"
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	60 #include "ov-complex.h"
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	61 #include "ov-flt-complex.h"
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	62 #include "ov-cx-mat.h"
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	63 #include "ov-flt-cx-mat.h"
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	64 #include "ov-cx-sparse.h"
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	65 #include "parse.h"
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	66 #include "pt-mat.h"
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	67 #include "utils.h"
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	68 #include "variables.h"
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	69 #include "pager.h"
8303 b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	70 #include "xnorm.h"
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	71
10303 e4899d6320b6 data.cc: use CLOCKS_PER_SEC instead of HZ John W. Eaton <jwe@octave.org> parents: 10302 diff changeset	72 #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	73 #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	74 #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	75 #else
10303 e4899d6320b6 data.cc: use CLOCKS_PER_SEC instead of HZ John W. Eaton <jwe@octave.org> parents: 10302 diff changeset	76 #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	77 #endif
5669a0b893db data.cc: include <sys/times.h> and ensure that HZ is defined John W. Eaton <jwe@octave.org> parents: 10293 diff changeset	78 #endif
5669a0b893db data.cc: include <sys/times.h> and ensure that HZ is defined John W. Eaton <jwe@octave.org> parents: 10293 diff changeset	79
7914 e998e81224b5 Various compilation fixes for MSVC. John W. Eaton <jwe@octave.org> parents: 7815 diff changeset	80 #if ! defined (HAVE_HYPOTF) && defined (HAVE__HYPOTF)
e998e81224b5 Various compilation fixes for MSVC. John W. Eaton <jwe@octave.org> parents: 7815 diff changeset	81 #define hypotf _hypotf
e998e81224b5 Various compilation fixes for MSVC. John W. Eaton <jwe@octave.org> parents: 7815 diff changeset	82 #define HAVE_HYPOTF 1
e998e81224b5 Various compilation fixes for MSVC. John W. Eaton <jwe@octave.org> parents: 7815 diff changeset	83 #endif
e998e81224b5 Various compilation fixes for MSVC. John W. Eaton <jwe@octave.org> parents: 7815 diff changeset	84
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	85 #define ANY_ALL(FCN) \
6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	86 \
4233 ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe] jwe parents: 4176 diff changeset	87 octave_value retval; \
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	88 \
6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	89 int nargin = args.length (); \
6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	90 \
4021 963507f8caf4 [project @ 2002-08-05 22:22:16 by jwe] jwe parents: 4015 diff changeset	91 if (nargin == 1 \|\| nargin == 2) \
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	92 { \
4021 963507f8caf4 [project @ 2002-08-05 22:22:16 by jwe] jwe parents: 4015 diff changeset	93 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	94 \
963507f8caf4 [project @ 2002-08-05 22:22:16 by jwe] jwe parents: 4015 diff changeset	95 if (! error_state) \
963507f8caf4 [project @ 2002-08-05 22:22:16 by jwe] jwe parents: 4015 diff changeset	96 { \
4556 773a21e4fce8 [project @ 2003-10-28 05:02:10 by jwe] jwe parents: 4554 diff changeset	97 if (dim >= -1) \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	98 retval = args(0).FCN (dim); \
4021 963507f8caf4 [project @ 2002-08-05 22:22:16 by jwe] jwe parents: 4015 diff changeset	99 else \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	100 error (#FCN ": invalid dimension argument = %d", dim + 1); \
4021 963507f8caf4 [project @ 2002-08-05 22:22:16 by jwe] jwe parents: 4015 diff changeset	101 } \
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	102 else \
4021 963507f8caf4 [project @ 2002-08-05 22:22:16 by jwe] jwe parents: 4015 diff changeset	103 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	104 } \
4021 963507f8caf4 [project @ 2002-08-05 22:22:16 by jwe] jwe parents: 4015 diff changeset	105 else \
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	106 print_usage (); \
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	107 \
6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	108 return retval
6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	109
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	110 DEFUN (all, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	111 "-- texinfo --\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	112 @deftypefn {Built-in Function} {} all (@var{x})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	113 @deftypefnx {Built-in Function} {} all (@var{x}, @var{dim})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	114 For a vector argument, return true (logical 1) if all elements of the vector\n\
18851 9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 18850 diff changeset	115 are nonzero.\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	116 \n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	117 For a matrix argument, return a row vector of logical ones and\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	118 zeros with each element indicating whether all of the elements of the\n\
18851 9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 18850 diff changeset	119 corresponding column of the matrix are nonzero. For example:\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	120 \n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	121 @example\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	122 @group\n\
18713 a142f35f3cb6 doc: Fix unbalanced parentheses in documentation. Rik <rik@octave.org> parents: 18712 diff changeset	123 all ([2, 3; 1, 0])\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	124 @result{} [ 1, 0 ]\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	125 @end group\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	126 @end example\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	127 \n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	128 If the optional argument @var{dim} is supplied, work along dimension\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	129 @var{dim}.\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	130 @seealso{any}\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	131 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	132 {
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	133 ANY_ALL (all);
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	134 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	135
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	136 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	137 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	138 %! 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	139 %! x(1,1) = 0;
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	140 %! assert (all (all (rand (3) + 1) == [1, 1, 1]) == 1);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	141 %! assert (all (all (x) == [0, 1, 1]) == 1);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	142 %! assert (all (x, 1) == [0, 1, 1]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	143 %! assert (all (x, 2) == [0; 1; 1]);
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	144
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	145 %!test
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	146 %! x = ones (3, "single");
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	147 %! x(1,1) = 0;
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	148 %! assert (all (all (single (rand (3) + 1)) == [1, 1, 1]) == 1);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	149 %! assert (all (all (x) == [0, 1, 1]) == 1);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	150 %! assert (all (x, 1) == [0, 1, 1]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	151 %! assert (all (x, 2) == [0; 1; 1]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	152
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	153 %!error all ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	154 %!error all (1, 2, 3)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	155 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	156
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	157 DEFUN (any, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	158 "-- texinfo --\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	159 @deftypefn {Built-in Function} {} any (@var{x})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	160 @deftypefnx {Built-in Function} {} any (@var{x}, @var{dim})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	161 For a vector argument, return true (logical 1) if any element of the vector\n\
18851 9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 18850 diff changeset	162 is nonzero.\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	163 \n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	164 For a matrix argument, return a row vector of logical ones and\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	165 zeros with each element indicating whether any of the elements of the\n\
18851 9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 18850 diff changeset	166 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	167 \n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	168 @example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	169 @group\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	170 any (eye (2, 4))\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	171 @result{} [ 1, 1, 0, 0 ]\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	172 @end group\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	173 @end example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	174 \n\
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	175 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	176 @var{dim}. For example:\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	177 \n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	178 @example\n\
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	179 @group\n\
6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	180 any (eye (2, 4), 2)\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	181 @result{} [ 1; 1 ]\n\
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	182 @end group\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	183 @end example\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	184 @seealso{all}\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	185 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	186 {
4015 6476dd85a65f [project @ 2002-08-02 07:59:19 by jwe] jwe parents: 3972 diff changeset	187 ANY_ALL (any);
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	188 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	189
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	190 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	191 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	192 %! 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	193 %! x(3,3) = 1;
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	194 %! assert (all (any (x) == [0, 0, 1]) == 1);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	195 %! assert (all (any (ones (3)) == [1, 1, 1]) == 1);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	196 %! assert (any (x, 1) == [0, 0, 1]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	197 %! assert (any (x, 2) == [0; 0; 1]);
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	198
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	199 %!test
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	200 %! x = zeros (3, "single");
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	201 %! x(3,3) = 1;
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	202 %! assert (all (any (x) == [0, 0, 1]) == 1);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	203 %! assert (all (any (ones (3, "single")) == [1, 1, 1]) == 1);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	204 %! assert (any (x, 1) == [0, 0, 1]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	205 %! assert (any (x, 2) == [0; 0; 1]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	206
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	207 %!error any ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	208 %!error any (1, 2, 3)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	209 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	210
649 1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	211 // 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	212
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	213 DEFUN (atan2, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	214 "-- texinfo --\n\
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	215 @deftypefn {Mapping Function} {} atan2 (@var{y}, @var{x})\n\
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	216 Compute atan (@var{y} / @var{x}) for corresponding elements of @var{y}\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	217 and @var{x}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	218 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	219 @var{y} and @var{x} must match in size and orientation.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	220 @seealso{tan, tand, tanh, atanh}\n\
3439 3234a698073a [project @ 2000-01-14 09:51:14 by jwe] jwe parents: 3428 diff changeset	221 @end deftypefn")
649 1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	222 {
4233 ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe] jwe parents: 4176 diff changeset	223 octave_value retval;
649 1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	224
712 36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	225 int nargin = args.length ();
36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	226
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	227 if (nargin == 2)
649 1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	228 {
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	229 if (! args(0).is_numeric_type ())
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	230 gripe_wrong_type_arg ("atan2", args(0));
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	231 else if (! args(1).is_numeric_type ())
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	232 gripe_wrong_type_arg ("atan2", args(1));
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	233 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	234 error ("atan2: not defined for complex numbers");
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	235 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	236 {
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	237 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	238 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	239 else
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	240 {
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	241 FloatNDArray a0 = args(0).float_array_value ();
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	242 FloatNDArray a1 = args(1).float_array_value ();
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	243 retval = binmap<float> (a0, a1, ::atan2f, "atan2");
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	244 }
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	245 }
7494 bd2bd04e68ca Treat integer types for mod/rem correctly David Bateman <dbateman@free.fr> parents: 7433 diff changeset	246 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	247 {
18823 dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	248 if (args(0).is_scalar_type () && args(1).is_scalar_type ())
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	249 retval = atan2 (args(0).scalar_value (), args(1).scalar_value ());
18823 dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	250 else if (args(0).is_sparse_type ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	251 {
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	252 SparseMatrix m0 = args(0).sparse_matrix_value ();
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	253 SparseMatrix m1 = args(1).sparse_matrix_value ();
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	254 retval = binmap<double> (m0, m1, ::atan2, "atan2");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	255 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	256 else
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	257 {
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	258 NDArray a0 = args(0).array_value ();
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	259 NDArray a1 = args(1).array_value ();
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	260 retval = binmap<double> (a0, a1, ::atan2, "atan2");
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	261 }
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	262 }
649 1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	263 }
712 36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	264 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	265 print_usage ();
649 1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	266
1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	267 return retval;
1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	268 }
1a674dba2e9e [project @ 1994-08-24 15:47:23 by jwe] jwe parents: 648 diff changeset	269
7506 798b0a00e80c atan2, fmod: accept N-d arrays John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	270 /*
7741 72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	271 %!assert (size (atan2 (zeros (0, 2), zeros (0, 2))), [0, 2])
72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	272 %!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	273 %!assert (size (atan2 (rand (2, 3, 4), 1)), [2, 3, 4])
72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	274 %!assert (size (atan2 (1, rand (2, 3, 4))), [2, 3, 4])
72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	275 %!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	276
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	277 %!test
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	278 %! rt2 = sqrt (2);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	279 %! rt3 = sqrt (3);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	280 %! 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	281 %! 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	282 %! x = [1, 3, 1, 1, 1, 1, 3, 1];
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	283 %! assert (atan2 (y, x), v, sqrt (eps));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	284
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	285 %!test
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	286 %! rt2 = sqrt (2);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	287 %! rt3 = sqrt (3);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	288 %! v = single ([0, pi/6, pi/4, pi/3, -pi/3, -pi/4, -pi/6, 0]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	289 %! y = single ([0, rt3, 1, rt3, -rt3, -1, -rt3, 0]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	290 %! x = single ([1, 3, 1, 1, 1, 1, 3, 1]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	291 %! assert (atan2 (y, x), v, sqrt (eps ("single")));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	292
18823 dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	293 ## Test sparse implementations
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	294 %!shared xs
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	295 %! xs = sparse (0:3);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	296 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	297 %! y = atan2 (1, xs);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	298 %! assert (issparse (y), false);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	299 %! assert (nnz (y), 4);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	300 %! assert (y, atan2 (1, 0:3));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	301 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	302 %! y = atan2 (0, xs);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	303 %! assert (issparse (y), false);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	304 %! assert (nnz (y), 0);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	305 %! assert (y, zeros (1,4));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	306 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	307 %! y = atan2 (xs, 1);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	308 %! assert (issparse (y));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	309 %! assert (nnz (y), 3);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	310 %! assert (y, sparse (atan2 (0:3, 1)));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	311 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	312 %! y = atan2 (xs, 0);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	313 %! assert (issparse (y));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	314 %! assert (nnz (y), 3);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	315 %! assert (y, sparse (atan2 (0:3, 0)));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	316 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	317 %! y = atan2 (xs, sparse (ones (1, 4)));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	318 %! assert (issparse (y));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	319 %! assert (nnz (y), 3);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	320 %! assert (y, sparse (atan2 (0:3, ones (1,4))));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	321 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	322 %! y = atan2 (xs, sparse (zeros (1,4)));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	323 %! assert (issparse (y));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	324 %! assert (nnz (y), 3);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	325 %! assert (y, sparse (atan2 (0:3, zeros (1,4))));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	326
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	327 %!error atan2 ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	328 %!error atan2 (1, 2, 3)
7506 798b0a00e80c atan2, fmod: accept N-d arrays John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	329 */
798b0a00e80c atan2, fmod: accept N-d arrays John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	330
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	331
10538 26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	332 static octave_value
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	333 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	334 {
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	335 octave_value retval;
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	336
18099 6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	337 octave_value arg0 = x;
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	338 octave_value arg1 = y;
10538 26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	339 if (! arg0.is_numeric_type ())
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	340 gripe_wrong_type_arg ("hypot", arg0);
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	341 else if (! arg1.is_numeric_type ())
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	342 gripe_wrong_type_arg ("hypot", arg1);
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	343 else
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	344 {
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	345 if (arg0.is_complex_type ())
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	346 arg0 = arg0.abs ();
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	347 if (arg1.is_complex_type ())
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	348 arg1 = arg1.abs ();
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	349
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	350 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	351 {
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	352 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	353 retval = hypotf (arg0.float_value (), arg1.float_value ());
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	354 else
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	355 {
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	356 FloatNDArray a0 = arg0.float_array_value ();
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	357 FloatNDArray a1 = arg1.float_array_value ();
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	358 retval = binmap<float> (a0, a1, ::hypotf, "hypot");
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	359 }
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	360 }
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	361 else
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	362 {
18823 dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	363 if (arg0.is_scalar_type () && arg1.is_scalar_type ())
10538 26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	364 retval = hypot (arg0.scalar_value (), arg1.scalar_value ());
18823 dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	365 else if (arg0.is_sparse_type () \|\| arg1.is_sparse_type ())
10538 26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	366 {
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	367 SparseMatrix m0 = arg0.sparse_matrix_value ();
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	368 SparseMatrix m1 = arg1.sparse_matrix_value ();
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	369 retval = binmap<double> (m0, m1, ::hypot, "hypot");
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	370 }
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	371 else
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	372 {
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	373 NDArray a0 = arg0.array_value ();
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	374 NDArray a1 = arg1.array_value ();
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	375 retval = binmap<double> (a0, a1, ::hypot, "hypot");
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	376 }
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	377 }
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	378 }
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	379
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	380 return retval;
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	381 }
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	382
7631 b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	383 DEFUN (hypot, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	384 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	385 @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	386 @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	387 Compute the element-by-element square root of the sum of the squares of\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	388 @var{x} and @var{y}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	389 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	390 This is equivalent to\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	391 @code{sqrt (@var{x}.^2 + @var{y}.^2)}, but is calculated in a manner that\n\
9165 8c71a86c4bf4 Update section 17.5 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9163 diff changeset	392 avoids overflows for large values of @var{x} or @var{y}.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	393 \n\
10538 26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	394 @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	395 the arguments are accumulated from left to right:\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	396 \n\
10538 26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	397 @example\n\
10711 fbd7843974fa Periodic grammar check of documentation files to ensure common format. Rik <octave@nomad.inbox5.com> parents: 10707 diff changeset	398 @group\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	399 hypot (hypot (@var{x}, @var{y}), @var{z})\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	400 hypot (hypot (hypot (@var{x}, @var{y}), @var{z}), @var{w}), etc.\n\
10711 fbd7843974fa Periodic grammar check of documentation files to ensure common format. Rik <octave@nomad.inbox5.com> parents: 10707 diff changeset	401 @end group\n\
10538 26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	402 @end example\n\
7631 b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	403 @end deftypefn")
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	404 {
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	405 octave_value retval;
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	406
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	407 int nargin = args.length ();
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	408
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	409 if (nargin == 2)
7631 b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	410 {
10538 26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	411 retval = do_hypot (args(0), args(1));
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	412 }
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	413 else if (nargin >= 3)
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	414 {
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	415 retval = args(0);
26673015caec extend hypot to accept >2 args Jaroslav Hajek <highegg@gmail.com> parents: 10533 diff changeset	416 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	417 retval = do_hypot (retval, args(i));
7631 b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	418 }
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	419 else
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	420 print_usage ();
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	421
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	422 return retval;
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	423 }
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	424
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	425 /*
7741 72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	426 %!assert (size (hypot (zeros (0, 2), zeros (0, 2))), [0, 2])
72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	427 %!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	428 %!assert (size (hypot (rand (2, 3, 4), 1)), [2, 3, 4])
72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	429 %!assert (size (hypot (1, rand (2, 3, 4))), [2, 3, 4])
72c0489653ac fix tests John W. Eaton <jwe@octave.org> parents: 7740 diff changeset	430 %!assert (size (hypot (1, 2)), [1, 1])
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	431 %!assert (hypot (1:10, 1:10), sqrt (2) * [1:10], 16*eps)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	432 %!assert (hypot (single (1:10), single (1:10)), single (sqrt (2) * [1:10]))
18823 dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	433
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	434 ## Test sparse implementations
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	435 %!shared xs
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	436 %! xs = sparse (0:3);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	437 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	438 %! y = hypot (1, xs);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	439 %! assert (nnz (y), 4);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	440 %! assert (y, sparse (hypot (1, 0:3)));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	441 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	442 %! y = hypot (0, xs);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	443 %! assert (nnz (y), 3);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	444 %! assert (y, xs);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	445 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	446 %! y = hypot (xs, 1);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	447 %! assert (nnz (y), 4);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	448 %! assert (y, sparse (hypot (0:3, 1)));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	449 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	450 %! y = hypot (xs, 0);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	451 %! assert (nnz (y), 3);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	452 %! assert (y, xs);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	453 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	454 %! y = hypot (sparse ([0 0]), sparse ([0 1]));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	455 %! assert (nnz (y), 1);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	456 %! assert (y, sparse ([0 1]));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	457 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	458 %! y = hypot (sparse ([0 1]), sparse ([0 0]));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	459 %! assert (nnz (y), 1);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	460 %! assert (y, sparse ([0 1]));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	461
7631 b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	462 */
b2a5cda5c549 Add the hypot function David Bateman <dbateman@free.fr> parents: 7623 diff changeset	463
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	464 template<typename T, typename ET>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	465 void
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	466 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	467 {
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	468 f = Array<T>(x.dims ());
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	469 e = Array<ET>(x.dims ());
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	470 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	471 {
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	472 int exp;
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	473 f.xelem (i) = xlog2 (x(i), exp);
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	474 e.xelem (i) = exp;
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 }
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	477
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	478 DEFUN (log2, args, nargout,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	479 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	480 @deftypefn {Mapping Function} {} log2 (@var{x})\n\
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	481 @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	482 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	483 \n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	484 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	485 binary mantissa and exponent so that\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	486 @tex\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	487 ${1 \\over 2} \\le \\left\| f \\right\| < 1$\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	488 @end tex\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	489 @ifnottex\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	490 @code{1/2 <= abs(f) < 1}\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	491 @end ifnottex\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	492 and @var{e} is an integer. If\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	493 @tex\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	494 $x = 0$, $f = e = 0$.\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	495 @end tex\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	496 @ifnottex\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	497 @code{x = 0}, @code{f = e = 0}.\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	498 @end ifnottex\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	499 @seealso{pow2, log, log10, exp}\n\
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	500 @end deftypefn")
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	501 {
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	502 octave_value_list retval;
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	503
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	504 if (args.length () == 1)
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	505 {
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	506 if (nargout < 2)
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	507 retval(0) = args(0).log2 ();
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	508 else if (args(0).is_single_type ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	509 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	510 if (args(0).is_real_type ())
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	511 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	512 FloatNDArray f;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	513 FloatNDArray x = args(0).float_array_value ();
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	514 // FIXME: should E be an int value?
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	515 FloatMatrix e;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	516 map_2_xlog2 (x, f, e);
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	517 retval(1) = e;
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	518 retval(0) = f;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	519 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	520 else if (args(0).is_complex_type ())
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	521 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	522 FloatComplexNDArray f;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	523 FloatComplexNDArray x = args(0).float_complex_array_value ();
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	524 // FIXME: should E be an int value?
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	525 FloatNDArray e;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	526 map_2_xlog2 (x, f, e);
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	527 retval(1) = e;
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	528 retval(0) = f;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	529 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	530 }
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	531 else if (args(0).is_real_type ())
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	532 {
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	533 NDArray f;
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	534 NDArray x = args(0).array_value ();
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	535 // FIXME: should E be an int value?
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	536 Matrix e;
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	537 map_2_xlog2 (x, f, e);
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	538 retval(1) = e;
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	539 retval(0) = f;
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	540 }
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	541 else if (args(0).is_complex_type ())
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	542 {
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	543 ComplexNDArray f;
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	544 ComplexNDArray x = args(0).complex_array_value ();
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	545 // FIXME: should E be an int value?
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	546 NDArray e;
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	547 map_2_xlog2 (x, f, e);
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	548 retval(1) = e;
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	549 retval(0) = f;
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	550 }
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	551 else
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	552 gripe_wrong_type_arg ("log2", args(0));
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	553 }
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	554 else
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	555 print_usage ();
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	556
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	557 return retval;
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	558 }
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	559
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	560 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	561 %!assert (log2 ([1/4, 1/2, 1, 2, 4]), [-2, -1, 0, 1, 2])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	562 %!assert (log2 (Inf), Inf)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	563 %!assert (isnan (log2 (NaN)))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	564 %!assert (log2 (4i), 2 + log2 (1i))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	565 %!assert (log2 (complex (0,Inf)), Inf + log2 (i))
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	566
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	567 %!test
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	568 %! [f, e] = log2 ([0,-1; 2,-4; Inf,-Inf]);
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	569 %! assert (f, [0,-0.5; 0.5,-0.5; Inf,-Inf]);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	570 %! assert (e(1:2,:), [0,1;2,3]);
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	571
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	572 %!test
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	573 %! [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	574 %! 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	575 %! assert (e(1:2,:), [0,1; 2,3]);
18885 9d185537e5d1 * data.cc: New test for log2 (bug #42583). John W. Eaton <jwe@octave.org> parents: 18848 diff changeset	576
9d185537e5d1 * data.cc: New test for log2 (bug #42583). John W. Eaton <jwe@octave.org> parents: 18848 diff changeset	577 # bug #42583
9d185537e5d1 * data.cc: New test for log2 (bug #42583). John W. Eaton <jwe@octave.org> parents: 18848 diff changeset	578 %!assert (all (log2 (pow2 (-1074:1023)) == -1074:1023))
9813 8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	579 */
8fa32b527d9a improve & partially revert previous change Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	580
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	581 DEFUN (rem, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	582 "-- texinfo --\n\
19152 9c5a17d5fc19 Deprecate fmod function. Rik <rik@octave.org> parents: 19113 diff changeset	583 @deftypefn {Mapping Function} {} rem (@var{x}, @var{y})\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	584 Return the remainder of the division @code{@var{x} / @var{y}}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	585 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	586 The remainder is computed using the expression\n\
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	587 \n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	588 @example\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	589 x - y .* fix (x ./ y)\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	590 @end example\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	591 \n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	592 An error message is printed if the dimensions of the arguments do not agree,\n\
20409 0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	593 or if either argument is complex.\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	594 \n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	595 Programming Notes: Floating point numbers within a few eps of an integer will\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	596 be rounded to an integer before computation for compatibility with\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	597 @sc{matlab}.\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	598 \n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	599 By convention,\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	600 \n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	601 @example\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	602 @group\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	603 rem (@var{x}, 0) = NaN if @var{x} is a floating point variable\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	604 rem (@var{x}, 0) = 0 if @var{x} is an integer variable\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	605 rem (@var{x}, @var{y}) returns a value with the signbit from @var{x}\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	606 @end group\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	607 @end example\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	608 \n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	609 For the opposite conventions see the @code{mod} function. In general,\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	610 @code{rem} is best when computing the remainder after division of two\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	611 @emph{positive} numbers. For negative numbers, or when the values are\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	612 periodic, @code{mod} is a better choice.\n\
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	613 @seealso{mod}\n\
4311 a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	614 @end deftypefn")
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	615 {
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	616 octave_value retval;
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	617
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	618 int nargin = args.length ();
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	619
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	620 if (nargin == 2)
4311 a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	621 {
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	622 if (! args(0).is_numeric_type ())
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	623 gripe_wrong_type_arg ("rem", args(0));
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	624 else if (! args(1).is_numeric_type ())
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	625 gripe_wrong_type_arg ("rem", args(1));
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	626 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	627 error ("rem: not defined for complex numbers");
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	628 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	629 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	630 builtin_type_t btyp0 = args(0).builtin_type ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	631 builtin_type_t btyp1 = args(1).builtin_type ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	632 if (btyp0 == btyp_double \|\| btyp0 == btyp_float)
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	633 btyp0 = btyp1;
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	634 if (btyp1 == btyp_double \|\| btyp1 == btyp_float)
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	635 btyp1 = btyp0;
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	636
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	637 if (btyp0 == btyp1)
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	638 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	639 switch (btyp0)
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	640 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	641 #define MAKE_INT_BRANCH(X) \
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	642 case btyp_ ## X: \
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	643 { \
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	644 X##NDArray a0 = args(0).X##_array_value (); \
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	645 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	646 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	647 } \
18760 5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18759 diff changeset	648 break;
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	649 MAKE_INT_BRANCH (int8);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	650 MAKE_INT_BRANCH (int16);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	651 MAKE_INT_BRANCH (int32);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	652 MAKE_INT_BRANCH (int64);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	653 MAKE_INT_BRANCH (uint8);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	654 MAKE_INT_BRANCH (uint16);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	655 MAKE_INT_BRANCH (uint32);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	656 MAKE_INT_BRANCH (uint64);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	657 #undef MAKE_INT_BRANCH
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	658 default:
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	659 panic_impossible ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	660 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	661 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	662 else
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	663 error ("rem: cannot combine %s and %d",
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	664 args(0).class_name ().c_str (),
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	665 args(1).class_name ().c_str ());
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	666 }
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	667 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	668 {
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	669 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	670 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	671 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	672 {
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	673 FloatNDArray a0 = args(0).float_array_value ();
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	674 FloatNDArray a1 = args(1).float_array_value ();
13731 3b52038e6e6c Help dumb compilers to resolve template parameters. Michael Goffioul <michael.goffioul@gmail.com> parents: 13294 diff changeset	675 retval = binmap<float> (a0, a1, xrem<float>, "rem");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	676 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	677 }
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	678 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	679 {
18823 dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	680 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	681 retval = xrem (args(0).scalar_value (), args(1).scalar_value ());
18823 dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	682 else if (args(0).is_sparse_type () \|\| args(1).is_sparse_type ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	683 {
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	684 SparseMatrix m0 = args(0).sparse_matrix_value ();
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	685 SparseMatrix m1 = args(1).sparse_matrix_value ();
13731 3b52038e6e6c Help dumb compilers to resolve template parameters. Michael Goffioul <michael.goffioul@gmail.com> parents: 13294 diff changeset	686 retval = binmap<double> (m0, m1, xrem<double>, "rem");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	687 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	688 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	689 {
10435 6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	690 NDArray a0 = args(0).array_value ();
6a271334750c implement general binary mapping facility Jaroslav Hajek <highegg@gmail.com> parents: 10405 diff changeset	691 NDArray a1 = args(1).array_value ();
13731 3b52038e6e6c Help dumb compilers to resolve template parameters. Michael Goffioul <michael.goffioul@gmail.com> parents: 13294 diff changeset	692 retval = binmap<double> (a0, a1, xrem<double>, "rem");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	693 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	694 }
4311 a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	695 }
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	696 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	697 print_usage ();
4311 a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	698
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	699 return retval;
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	700 }
a9e0bff33b02 [project @ 2003-01-30 04:11:58 by jwe] jwe parents: 4303 diff changeset	701
7506 798b0a00e80c atan2, fmod: accept N-d arrays John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	702 /*
19152 9c5a17d5fc19 Deprecate fmod function. Rik <rik@octave.org> parents: 19113 diff changeset	703 %!assert (size (rem (zeros (0, 2), zeros (0, 2))), [0, 2])
9c5a17d5fc19 Deprecate fmod function. Rik <rik@octave.org> parents: 19113 diff changeset	704 %!assert (size (rem (rand (2, 3, 4), zeros (2, 3, 4))), [2, 3, 4])
9c5a17d5fc19 Deprecate fmod function. Rik <rik@octave.org> parents: 19113 diff changeset	705 %!assert (size (rem (rand (2, 3, 4), 1)), [2, 3, 4])
9c5a17d5fc19 Deprecate fmod function. Rik <rik@octave.org> parents: 19113 diff changeset	706 %!assert (size (rem (1, rand (2, 3, 4))), [2, 3, 4])
9c5a17d5fc19 Deprecate fmod function. Rik <rik@octave.org> parents: 19113 diff changeset	707 %!assert (size (rem (1, 2)), [1, 1])
18823 dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	708
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	709 %!assert (rem ([1, 2, 3; -1, -2, -3], 2), [1, 0, 1; -1, 0, -1])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	710 %!assert (rem ([1, 2, 3; -1, -2, -3], 2 * ones (2, 3)),[1, 0, 1; -1, 0, -1])
20409 0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	711 %!assert (rem ([0, 1, 2], [0, 0, 1]), [NaN, NaN, 0]);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	712 %!assert (rem (uint8 ([1, 2, 3; -1, -2, -3]), uint8 (2)), uint8 ([1, 0, 1; -1, 0, -1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	713 %!assert (uint8 (rem ([1, 2, 3; -1, -2, -3], 2 * ones (2, 3))),uint8 ([1, 0, 1; -1, 0, -1]))
20409 0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	714 %!assert (rem (uint8 ([0, 1, 2]), [0, 0, 1]), uint8 ([0, 0, 0]));
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	715
18823 dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	716 ## Test sparse implementations
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	717 %!shared xs
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	718 %! xs = sparse (0:3);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	719 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	720 %! y = rem (11, xs);
20409 0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	721 %! assert (isnan (y(1)));
18823 dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	722 %! assert (y, sparse (rem (11, 0:3)));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	723 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	724 %! y = rem (0, xs);
20409 0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	725 %! assert (nnz (y), 1);
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	726 %! assert (y, sparse ([NaN 0 0 0]));
18823 dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	727 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	728 %! y = rem (xs, 2);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	729 %! assert (nnz (y), 2);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	730 %! assert (y, sparse (rem (0:3, 2)));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	731 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	732 %! y = rem (xs, 1);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	733 %! assert (nnz (y), 0);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	734 %! assert (y, sparse (rem (0:3, 1)));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	735 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	736 %! y = rem (sparse ([11 11 11 11]), xs);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	737 %! assert (nnz (y), 3);
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	738 %! assert (y, sparse (rem (11, 0:3)));
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	739 %!test
dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	740 %! y = rem (sparse ([0 0 0 0]), xs);
20409 0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	741 %! assert (nnz (y), 1);
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	742 %! assert (y, sparse ([NaN 0 0 0]));
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	743
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	744 ## Bug #45587
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	745 %!assert (signbit (rem (-0, 1)))
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	746 %!assert (! signbit (rem (0, 1)))
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	747
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	748 ## bug #42627
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	749 %!assert (rem (0.94, 0.01), 0.0)
18823 dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	750
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	751 %!error rem (uint (8), int8 (5))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	752 %!error rem (uint8 ([1, 2]), uint8 ([3, 4, 5]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	753 %!error rem ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	754 %!error rem (1, 2, 3)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	755 %!error rem ([1, 2], [3, 4, 5])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	756 %!error rem (i, 1)
7506 798b0a00e80c atan2, fmod: accept N-d arrays John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	757 */
798b0a00e80c atan2, fmod: accept N-d arrays John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	758
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	759 DEFUN (mod, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	760 "-- texinfo --\n\
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	761 @deftypefn {Mapping Function} {} mod (@var{x}, @var{y})\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	762 Compute the modulo of @var{x} and @var{y}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	763 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	764 Conceptually this is given by\n\
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	765 \n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	766 @example\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	767 x - y .* floor (x ./ y)\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	768 @end example\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	769 \n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	770 @noindent\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	771 and is written such that the correct modulus is returned for integer types.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	772 This function handles negative values correctly. That is,\n\
20409 0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	773 @w{@code{mod (-1, 3)}} is 2, not -1, as @w{@code{rem (-1, 3)}} returns.\n\
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	774 \n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	775 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	776 either of the arguments is complex.\n\
20409 0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	777 \n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	778 Programming Notes: Floating point numbers within a few eps of an integer will\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	779 be rounded to an integer before computation for compatibility with\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	780 @sc{matlab}.\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	781 \n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	782 By convention,\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	783 \n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	784 @example\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	785 @group\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	786 mod (@var{x}, 0) = @var{x}\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	787 mod (@var{x}, @var{y}) returns a value with the signbit from @var{y}\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	788 @end group\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	789 @end example\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	790 \n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	791 For the opposite conventions see the @code{rem} function. In general,\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	792 @code{mod} is a better choice than @code{rem} when any of the inputs are\n\
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	793 negative numbers or when the values are periodic.\n\
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	794 @seealso{rem}\n\
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	795 @end deftypefn")
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	796 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	797 octave_value retval;
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	798
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	799 int nargin = args.length ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	800
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	801 if (nargin == 2)
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	802 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	803 if (! args(0).is_numeric_type ())
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	804 gripe_wrong_type_arg ("mod", args(0));
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	805 else if (! args(1).is_numeric_type ())
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	806 gripe_wrong_type_arg ("mod", args(1));
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	807 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	808 error ("mod: not defined for complex numbers");
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	809 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	810 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	811 builtin_type_t btyp0 = args(0).builtin_type ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	812 builtin_type_t btyp1 = args(1).builtin_type ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	813 if (btyp0 == btyp_double \|\| btyp0 == btyp_float)
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	814 btyp0 = btyp1;
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	815 if (btyp1 == btyp_double \|\| btyp1 == btyp_float)
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	816 btyp1 = btyp0;
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	817
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	818 if (btyp0 == btyp1)
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	819 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	820 switch (btyp0)
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	821 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	822 #define MAKE_INT_BRANCH(X) \
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	823 case btyp_ ## X: \
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	824 { \
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	825 X##NDArray a0 = args(0).X##_array_value (); \
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	826 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	827 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	828 } \
18760 5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18759 diff changeset	829 break;
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	830 MAKE_INT_BRANCH (int8);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	831 MAKE_INT_BRANCH (int16);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	832 MAKE_INT_BRANCH (int32);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	833 MAKE_INT_BRANCH (int64);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	834 MAKE_INT_BRANCH (uint8);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	835 MAKE_INT_BRANCH (uint16);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	836 MAKE_INT_BRANCH (uint32);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	837 MAKE_INT_BRANCH (uint64);
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	838 #undef MAKE_INT_BRANCH
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	839 default:
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	840 panic_impossible ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	841 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	842 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	843 else
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	844 error ("mod: cannot combine %s and %d",
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	845 args(0).class_name ().c_str (),
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	846 args(1).class_name ().c_str ());
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	847 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	848 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	849 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	850 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	851 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	852 else
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	853 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	854 FloatNDArray a0 = args(0).float_array_value ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	855 FloatNDArray a1 = args(1).float_array_value ();
13731 3b52038e6e6c Help dumb compilers to resolve template parameters. Michael Goffioul <michael.goffioul@gmail.com> parents: 13294 diff changeset	856 retval = binmap<float> (a0, a1, xmod<float>, "mod");
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	857 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	858 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	859 else
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	860 {
18823 dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	861 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	862 retval = xmod (args(0).scalar_value (), args(1).scalar_value ());
18823 dccbc8bff5cb Fix binmap for sparse-scalar or scalar-sparse operations (bug #40813). Rik <rik@octave.org> parents: 18809 diff changeset	863 else if (args(0).is_sparse_type () \|\| args(1).is_sparse_type ())
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	864 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	865 SparseMatrix m0 = args(0).sparse_matrix_value ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	866 SparseMatrix m1 = args(1).sparse_matrix_value ();
13731 3b52038e6e6c Help dumb compilers to resolve template parameters. Michael Goffioul <michael.goffioul@gmail.com> parents: 13294 diff changeset	867 retval = binmap<double> (m0, m1, xmod<double>, "mod");
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	868 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	869 else
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	870 {
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	871 NDArray a0 = args(0).array_value ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	872 NDArray a1 = args(1).array_value ();
13731 3b52038e6e6c Help dumb compilers to resolve template parameters. Michael Goffioul <michael.goffioul@gmail.com> parents: 13294 diff changeset	873 retval = binmap<double> (a0, a1, xmod<double>, "mod");
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	874 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	875 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	876 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	877 else
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	878 print_usage ();
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	879
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	880 return retval;
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	881 }
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	882
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	883 /*
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	884 ## empty input test
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	885 %!assert (isempty (mod ([], [])))
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	886
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	887 ## x mod y, y != 0 tests
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	888 %!assert (mod (5, 3), 2)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	889 %!assert (mod (-5, 3), 1)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	890 %!assert (mod (0, 3), 0)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	891 %!assert (mod ([-5, 5, 0], [3, 3, 3]), [1, 2, 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	892 %!assert (mod ([-5; 5; 0], [3; 3; 3]), [1; 2; 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	893 %!assert (mod ([-5, 5; 0, 3], [3, 3 ; 3, 1]), [1, 2 ; 0, 0])
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	894
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	895 ## x mod 0 tests
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	896 %!assert (mod (5, 0), 5)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	897 %!assert (mod (-5, 0), -5)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	898 %!assert (mod ([-5, 5, 0], [3, 0, 3]), [1, 5, 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	899 %!assert (mod ([-5; 5; 0], [3; 0; 3]), [1; 5; 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	900 %!assert (mod ([-5, 5; 0, 3], [3, 0 ; 3, 1]), [1, 5 ; 0, 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	901 %!assert (mod ([-5, 5; 0, 3], [0, 0 ; 0, 0]), [-5, 5; 0, 3])
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	902
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	903 ## mixed scalar/matrix tests
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	904 %!assert (mod ([-5, 5; 0, 3], 0), [-5, 5; 0, 3])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	905 %!assert (mod ([-5, 5; 0, 3], 3), [1, 2; 0, 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	906 %!assert (mod (-5, [0,0; 0,0]), [-5, -5; -5, -5])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	907 %!assert (mod (-5, [3,0; 3,1]), [1, -5; 1, 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	908 %!assert (mod (-5, [3,2; 3,1]), [1, 1; 1, 0])
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	909
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	910 ## integer types
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	911 %!assert (mod (uint8 (5), uint8 (4)), uint8 (1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	912 %!assert (mod (uint8 ([1:5]), uint8 (4)), uint8 ([1,2,3,0,1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	913 %!assert (mod (uint8 ([1:5]), uint8 (0)), uint8 ([1:5]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	914 %!error (mod (uint8 (5), int8 (4)))
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	915
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	916 ## mixed integer/real types
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	917 %!assert (mod (uint8 (5), 4), uint8 (1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	918 %!assert (mod (5, uint8 (4)), uint8 (1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	919 %!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	920
903c1a3df301 Add additional tests for mod with non-integer real values. Rik <octave@nomad.inbox5.com> parents: 11242 diff changeset	921 ## non-integer real numbers
903c1a3df301 Add additional tests for mod with non-integer real values. Rik <octave@nomad.inbox5.com> parents: 11242 diff changeset	922 %!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	923 %!assert (mod (2.1, 0.2), 0.1, eps)
18903 23681c9ea7ba better guess if rem or mod could be zero (bug #42627) Olaf Till <i7tiol@t-online.de> parents: 18885 diff changeset	924
20409 0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	925 ## Bug #45587
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	926 %!assert (signbit (mod (-0, 0)))
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	927 %!assert (! signbit (mod (0, -0)))
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	928
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	929 ## Bug #42627
0cefba1a1030 Make mod() and rem() Matlab compatible for corner cases (bug #45587). Rik <rik@octave.org> parents: 20267 diff changeset	930 %!assert (mod (0.94, 0.01), 0.0)
10436 00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	931 */
00219bdd2d17 implement built-in rem and mod Jaroslav Hajek <highegg@gmail.com> parents: 10435 diff changeset	932
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	933 // FIXME: Need to convert reduction functions of this file for single precision
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	934
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	935 #define NATIVE_REDUCTION_1(FCN, TYPE, DIM) \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	936 (arg.is_ ## TYPE ## _type ()) \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	937 { \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	938 TYPE ## NDArray tmp = arg. TYPE ##_array_value (); \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	939 \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	940 if (! error_state) \
8780 ea76466605ba support native cumsum, gripe on overflow in sum/cumsum Jaroslav Hajek <highegg@gmail.com> parents: 8756 diff changeset	941 { \
ea76466605ba support native cumsum, gripe on overflow in sum/cumsum Jaroslav Hajek <highegg@gmail.com> parents: 8756 diff changeset	942 retval = tmp.FCN (DIM); \
ea76466605ba support native cumsum, gripe on overflow in sum/cumsum Jaroslav Hajek <highegg@gmail.com> parents: 8756 diff changeset	943 } \
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	944 }
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	945
8780 ea76466605ba support native cumsum, gripe on overflow in sum/cumsum Jaroslav Hajek <highegg@gmail.com> parents: 8756 diff changeset	946 #define NATIVE_REDUCTION(FCN, BOOL_FCN) \
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	947 \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	948 octave_value retval; \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	949 \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	950 int nargin = args.length (); \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	951 \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	952 bool isnative = false; \
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	953 bool isdouble = false; \
7112 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 if (nargin > 1 && args(nargin - 1).is_string ()) \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	956 { \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	957 std::string str = args(nargin - 1).string_value (); \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	958 \
19777 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	959 if (str == "native") \
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	960 isnative = true; \
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	961 else if (str == "double") \
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	962 isdouble = true; \
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	963 else \
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	964 error ("sum: unrecognized string argument"); \
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	965 nargin --; \
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	966 } \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	967 \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	968 if (nargin == 1 \|\| nargin == 2) \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	969 { \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	970 octave_value arg = args(0); \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	971 \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	972 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	973 \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	974 if (! error_state) \
10315 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 (dim >= -1) \
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 if (arg.is_real_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	981 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	982 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	983 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	984 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	985 retval = tmp.FCN (dim); \
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 else \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	988 { \
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	989 SparseComplexMatrix tmp \
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	990 = arg.sparse_complex_matrix_value (); \
10315 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 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	993 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	994 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	995 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	996 else \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	997 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	998 if (isnative) \
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 if NATIVE_REDUCTION_1 (FCN, uint8, dim) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1001 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	1002 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	1003 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	1004 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	1005 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	1006 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	1007 else if NATIVE_REDUCTION_1 (FCN, int64, dim) \
8756 d0755c9db5ed implement fast logical sum (counting) Jaroslav Hajek <highegg@gmail.com> parents: 8734 diff changeset	1008 else if (arg.is_bool_type ()) \
d0755c9db5ed implement fast logical sum (counting) Jaroslav Hajek <highegg@gmail.com> parents: 8734 diff changeset	1009 { \
8780 ea76466605ba support native cumsum, gripe on overflow in sum/cumsum Jaroslav Hajek <highegg@gmail.com> parents: 8756 diff changeset	1010 boolNDArray tmp = arg.bool_array_value (); \
8756 d0755c9db5ed implement fast logical sum (counting) Jaroslav Hajek <highegg@gmail.com> parents: 8734 diff changeset	1011 if (! error_state) \
8780 ea76466605ba support native cumsum, gripe on overflow in sum/cumsum Jaroslav Hajek <highegg@gmail.com> parents: 8756 diff changeset	1012 retval = boolNDArray (tmp.BOOL_FCN (dim)); \
8756 d0755c9db5ed implement fast logical sum (counting) Jaroslav Hajek <highegg@gmail.com> parents: 8734 diff changeset	1013 } \
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7506 diff changeset	1014 else if (arg.is_char_matrix ()) \
f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7506 diff changeset	1015 { \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1016 error (#FCN, ": invalid char type"); \
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 else if (!isdouble && arg.is_single_type ()) \
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	1019 { \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1020 if (arg.is_complex_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1021 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1022 FloatComplexNDArray tmp = \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1023 arg.float_complex_array_value (); \
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	1024 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1025 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1026 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1027 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1028 else if (arg.is_real_type ()) \
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 FloatNDArray tmp = arg.float_array_value (); \
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	1031 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1032 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1033 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1034 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1035 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1036 else if (arg.is_complex_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1037 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1038 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	1039 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1040 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1041 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1042 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1043 else if (arg.is_real_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1044 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1045 NDArray tmp = arg.array_value (); \
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7506 diff changeset	1046 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1047 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1048 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1049 } \
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7506 diff changeset	1050 else \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1051 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1052 gripe_wrong_type_arg (#FCN, arg); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1053 return retval; \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1054 } \
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	1055 } \
8756 d0755c9db5ed implement fast logical sum (counting) Jaroslav Hajek <highegg@gmail.com> parents: 8734 diff changeset	1056 else if (arg.is_bool_type ()) \
d0755c9db5ed implement fast logical sum (counting) Jaroslav Hajek <highegg@gmail.com> parents: 8734 diff changeset	1057 { \
d0755c9db5ed implement fast logical sum (counting) Jaroslav Hajek <highegg@gmail.com> parents: 8734 diff changeset	1058 boolNDArray tmp = arg.bool_array_value (); \
d0755c9db5ed implement fast logical sum (counting) Jaroslav Hajek <highegg@gmail.com> parents: 8734 diff changeset	1059 if (! error_state) \
d0755c9db5ed implement fast logical sum (counting) Jaroslav Hajek <highegg@gmail.com> parents: 8734 diff changeset	1060 retval = tmp.FCN (dim); \
d0755c9db5ed implement fast logical sum (counting) Jaroslav Hajek <highegg@gmail.com> parents: 8734 diff changeset	1061 } \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1062 else if (!isdouble && arg.is_single_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1063 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1064 if (arg.is_real_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1065 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1066 FloatNDArray tmp = arg.float_array_value (); \
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	1067 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1068 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1069 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1070 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1071 else if (arg.is_complex_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1072 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1073 FloatComplexNDArray tmp = \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1074 arg.float_complex_array_value (); \
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	1075 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1076 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1077 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1078 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1079 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1080 else if (arg.is_real_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1081 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1082 NDArray tmp = arg.array_value (); \
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7506 diff changeset	1083 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1084 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1085 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1086 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1087 else if (arg.is_complex_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1088 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1089 ComplexNDArray tmp = arg.complex_array_value (); \
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	1090 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1091 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1092 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1093 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1094 else \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1095 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1096 gripe_wrong_type_arg (#FCN, arg); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1097 return retval; \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1098 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1099 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1100 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1101 else \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1102 error (#FCN ": invalid dimension argument = %d", dim + 1); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1103 } \
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	1104 \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	1105 } \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	1106 else \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	1107 print_usage (); \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	1108 \
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	1109 return retval
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	1110
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1111 #define DATA_REDUCTION(FCN) \
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1112 \
4233 ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe] jwe parents: 4176 diff changeset	1113 octave_value retval; \
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1114 \
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1115 int nargin = args.length (); \
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1116 \
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1117 if (nargin == 1 \|\| nargin == 2) \
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1118 { \
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1119 octave_value arg = args(0); \
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1120 \
3864 e78705239df5 [project @ 2001-11-16 12:56:20 by jwe] jwe parents: 3797 diff changeset	1121 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	1122 \
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1123 if (! error_state) \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1124 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1125 if (dim >= -1) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1126 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1127 if (arg.is_real_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1128 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1129 if (arg.is_sparse_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1130 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1131 SparseMatrix tmp = arg.sparse_matrix_value (); \
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1132 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1133 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1134 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1135 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1136 else if (arg.is_single_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1137 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1138 FloatNDArray tmp = arg.float_array_value (); \
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	1139 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1140 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1141 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1142 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1143 else \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1144 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1145 NDArray tmp = arg.array_value (); \
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7506 diff changeset	1146 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1147 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1148 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1149 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1150 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1151 else if (arg.is_complex_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1152 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1153 if (arg.is_sparse_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1154 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1155 SparseComplexMatrix tmp = arg.sparse_complex_matrix_value (); \
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1156 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1157 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1158 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1159 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1160 else if (arg.is_single_type ()) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1161 { \
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1162 FloatComplexNDArray tmp \
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1163 = arg.float_complex_array_value (); \
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	1164 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1165 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1166 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1167 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1168 else \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1169 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1170 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	1171 \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1172 if (! error_state) \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1173 retval = tmp.FCN (dim); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1174 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1175 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1176 else \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1177 { \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1178 gripe_wrong_type_arg (#FCN, arg); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1179 return retval; \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1180 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1181 } \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1182 else \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1183 error (#FCN ": invalid dimension argument = %d", dim + 1); \
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1184 } \
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1185 } \
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1186 else \
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	1187 print_usage (); \
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1188 \
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1189 return retval
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1190
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	1191 DEFUN (cumprod, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1192 "-- texinfo --\n\
9163 9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	1193 @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	1194 @deftypefnx {Built-in Function} {} cumprod (@var{x}, @var{dim})\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1195 Cumulative product of elements along dimension @var{dim}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1196 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1197 If @var{dim} is 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	1198 @seealso{prod, cumsum}\n\
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	1199 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1200 {
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	1201 DATA_REDUCTION (cumprod);
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1202 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1203
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1204 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1205 %!assert (cumprod ([1, 2, 3]), [1, 2, 6])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1206 %!assert (cumprod ([-1; -2; -3]), [-1; 2; -6])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1207 %!assert (cumprod ([i, 2+i, -3+2i, 4]), [i, -1+2i, -1-8i, -4-32i])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1208 %!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])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1209
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1210 %!assert (cumprod (single ([1, 2, 3])), single ([1, 2, 6]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1211 %!assert (cumprod (single ([-1; -2; -3])), single ([-1; 2; -6]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1212 %!assert (cumprod (single ([i, 2+i, -3+2i, 4])), single ([i, -1+2i, -1-8i, -4-32i]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1213 %!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]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1214
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1215 %!assert (cumprod ([2, 3; 4, 5], 1), [2, 3; 8, 15])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1216 %!assert (cumprod ([2, 3; 4, 5], 2), [2, 6; 4, 20])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1217
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1218 %!assert (cumprod (single ([2, 3; 4, 5]), 1), single ([2, 3; 8, 15]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1219 %!assert (cumprod (single ([2, 3; 4, 5]), 2), single ([2, 6; 4, 20]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1220
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1221 %!error cumprod ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1222 */
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1223
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	1224 DEFUN (cumsum, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1225 "-- texinfo --\n\
9163 9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	1226 @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	1227 @deftypefnx {Built-in Function} {} cumsum (@var{x}, @var{dim})\n\
14361 8de863b7126b doc: Use Octave preference for double quote in docstrings in all .cc files Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1228 @deftypefnx {Built-in Function} {} cumsum (@dots{}, \"native\")\n\
8de863b7126b doc: Use Octave preference for double quote in docstrings in all .cc files Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1229 @deftypefnx {Built-in Function} {} cumsum (@dots{}, \"double\")\n\
8de863b7126b doc: Use Octave preference for double quote in docstrings in all .cc files Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1230 @deftypefnx {Built-in Function} {} cumsum (@dots{}, \"extra\")\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1231 Cumulative sum of elements along dimension @var{dim}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1232 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1233 If @var{dim} 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	1234 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	1235 See @code{sum} for an explanation of the optional parameters\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	1236 @qcode{\"native\"}, @qcode{\"double\"}, and @qcode{\"extra\"}.\n\
9163 9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	1237 @seealso{sum, cumprod}\n\
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	1238 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1239 {
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1240 octave_value retval;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1241
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1242 int nargin = args.length ();
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1243
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1244 bool isnative = false;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1245 bool isdouble = false;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1246
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1247 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	1248 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1249 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	1250
19777 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	1251 if (str == "native")
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	1252 isnative = true;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	1253 else if (str == "double")
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	1254 isdouble = true;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	1255 else
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	1256 error ("cumsum: unrecognized string argument");
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	1257 nargin --;
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1258 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1259
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1260 if (error_state)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1261 return retval;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1262
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1263 if (nargin == 1 \|\| nargin == 2)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1264 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1265 octave_value arg = args(0);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1266
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1267 int dim = -1;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1268 if (nargin == 2)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1269 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1270 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	1271 if (dim < 0)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1272 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	1273 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1274
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1275 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1276 {
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1277 switch (arg.builtin_type ())
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1278 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1279 case btyp_double:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1280 if (arg.is_sparse_type ())
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1281 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	1282 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1283 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	1284 break;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1285 case btyp_complex:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1286 if (arg.is_sparse_type ())
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1287 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	1288 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1289 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	1290 break;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1291 case btyp_float:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1292 if (isdouble)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1293 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	1294 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1295 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	1296 break;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1297 case btyp_float_complex:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1298 if (isdouble)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1299 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	1300 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1301 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	1302 break;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1303
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1304 #define MAKE_INT_BRANCH(X) \
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1305 case btyp_ ## X: \
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1306 if (isnative) \
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1307 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	1308 else \
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1309 retval = arg.array_value ().cumsum (dim); \
18760 5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18759 diff changeset	1310 break;
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1311 MAKE_INT_BRANCH (int8);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1312 MAKE_INT_BRANCH (int16);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1313 MAKE_INT_BRANCH (int32);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1314 MAKE_INT_BRANCH (int64);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1315 MAKE_INT_BRANCH (uint8);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1316 MAKE_INT_BRANCH (uint16);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1317 MAKE_INT_BRANCH (uint32);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1318 MAKE_INT_BRANCH (uint64);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1319 #undef MAKE_INT_BRANCH
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1320
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1321 case btyp_bool:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1322 if (arg.is_sparse_type ())
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1323 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1324 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	1325 if (isnative)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1326 retval = cs != 0.0;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1327 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1328 retval = cs;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1329 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1330 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1331 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1332 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	1333 if (isnative)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1334 retval = cs != 0.0;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1335 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1336 retval = cs;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1337 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1338 break;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1339
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1340 default:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1341 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	1342 }
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1343 }
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1344 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1345 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1346 print_usage ();
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1347
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	1348 return retval;
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1349 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1350
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1351 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1352 %!assert (cumsum ([1, 2, 3]), [1, 3, 6])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1353 %!assert (cumsum ([-1; -2; -3]), [-1; -3; -6])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1354 %!assert (cumsum ([i, 2+i, -3+2i, 4]), [i, 2+2i, -1+4i, 3+4i])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1355 %!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])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1356
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1357 %!assert (cumsum (single ([1, 2, 3])), single ([1, 3, 6]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1358 %!assert (cumsum (single ([-1; -2; -3])), single ([-1; -3; -6]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1359 %!assert (cumsum (single ([i, 2+i, -3+2i, 4])), single ([i, 2+2i, -1+4i, 3+4i]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1360 %!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]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1361
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1362 %!assert (cumsum ([1, 2; 3, 4], 1), [1, 2; 4, 6])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1363 %!assert (cumsum ([1, 2; 3, 4], 2), [1, 3; 3, 7])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1364
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1365 %!assert (cumsum (single ([1, 2; 3, 4]), 1), single ([1, 2; 4, 6]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1366 %!assert (cumsum (single ([1, 2; 3, 4]), 2), single ([1, 3; 3, 7]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1367
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1368 %!error cumsum ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1369 */
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1370
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	1371 DEFUN (diag, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1372 "-- texinfo --\n\
12567 cc8ccdfec424 Remove archaic 3-input argument form of diag function. Rik <octave@nomad.inbox5.com> parents: 12546 diff changeset	1373 @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	1374 @deftypefnx {Built-in Function} {@var{M} =} diag (@var{v}, @var{k})\n\
12571 bed932910eb9 Add documentation for 3-input form of diag(). Add new tests. Rik <octave@nomad.inbox5.com> parents: 12570 diff changeset	1375 @deftypefnx {Built-in Function} {@var{M} =} diag (@var{v}, @var{m}, @var{n})\n\
12567 cc8ccdfec424 Remove archaic 3-input argument form of diag function. Rik <octave@nomad.inbox5.com> parents: 12546 diff changeset	1376 @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	1377 @deftypefnx {Built-in Function} {@var{v} =} diag (@var{M}, @var{k})\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1378 Return a diagonal matrix with vector @var{v} on diagonal @var{k}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1379 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1380 The second argument is optional. If it is positive, the vector is placed on\n\
19072 9e3c35d934ab doc: Periodic spell check of documentation. Rik <rik@octave.org> parents: 18907 diff changeset	1381 the @var{k}-th superdiagonal. If it is negative, it is placed on the\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1382 @var{-k}-th subdiagonal. The default value of @var{k} is 0, and the vector\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1383 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	1384 \n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	1385 @example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	1386 @group\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	1387 diag ([1, 2, 3], 1)\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	1388 @result{} 0 1 0 0\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	1389 0 0 2 0\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	1390 0 0 0 3\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	1391 0 0 0 0\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	1392 @end group\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	1393 @end example\n\
6772 315bc7c8f9b5 [project @ 2007-07-10 09:51:39 by dbateman] dbateman parents: 6688 diff changeset	1394 \n\
315bc7c8f9b5 [project @ 2007-07-10 09:51:39 by dbateman] dbateman parents: 6688 diff changeset	1395 @noindent\n\
12571 bed932910eb9 Add documentation for 3-input form of diag(). Add new tests. Rik <octave@nomad.inbox5.com> parents: 12570 diff changeset	1396 The 3-input form returns a diagonal matrix with vector @var{v} on the main\n\
bed932910eb9 Add documentation for 3-input form of diag(). Add new tests. Rik <octave@nomad.inbox5.com> parents: 12570 diff changeset	1397 diagonal and the resulting matrix being of size @var{m} rows x @var{n}\n\
bed932910eb9 Add documentation for 3-input form of diag(). Add new tests. Rik <octave@nomad.inbox5.com> parents: 12570 diff changeset	1398 columns.\n\
bed932910eb9 Add documentation for 3-input form of diag(). Add new tests. Rik <octave@nomad.inbox5.com> parents: 12570 diff changeset	1399 \n\
6772 315bc7c8f9b5 [project @ 2007-07-10 09:51:39 by dbateman] dbateman parents: 6688 diff changeset	1400 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	1401 @var{k}-th diagonal of the matrix.\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	1402 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1403 {
4233 ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe] jwe parents: 4176 diff changeset	1404 octave_value retval;
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1405
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1406 int nargin = args.length ();
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1407
712 36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	1408 if (nargin == 1 && args(0).is_defined ())
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1409 retval = args(0).diag ();
712 36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	1410 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	1411 {
36594d5bbe13 Move diag function into the octave_value class David Bateman <dbateman@free.fr> parents: 7618 diff changeset	1412 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	1413
36594d5bbe13 Move diag function into the octave_value class David Bateman <dbateman@free.fr> parents: 7618 diff changeset	1414 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	1415 error ("diag: invalid argument K");
7620 36594d5bbe13 Move diag function into the octave_value class David Bateman <dbateman@free.fr> parents: 7618 diff changeset	1416 else
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1417 retval = args(0).diag (k);
7620 36594d5bbe13 Move diag function into the octave_value class David Bateman <dbateman@free.fr> parents: 7618 diff changeset	1418 }
12570 1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1419 else if (nargin == 3)
1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1420 {
1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1421 octave_value arg0 = args(0);
14557 e8e86ae3abbc make diag (x, m, n) return a proper diagonal matrix object (bug #36099) John W. Eaton <jwe@octave.org> parents: 14521 diff changeset	1422
e8e86ae3abbc make diag (x, m, n) return a proper diagonal matrix object (bug #36099) John W. Eaton <jwe@octave.org> parents: 14521 diff changeset	1423 if (arg0.ndims () == 2 && (arg0.rows () == 1 \|\| arg0.columns () == 1))
12570 1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1424 {
14557 e8e86ae3abbc make diag (x, m, n) return a proper diagonal matrix object (bug #36099) John W. Eaton <jwe@octave.org> parents: 14521 diff changeset	1425 octave_idx_type m = args(1).int_value ();
e8e86ae3abbc make diag (x, m, n) return a proper diagonal matrix object (bug #36099) John W. Eaton <jwe@octave.org> parents: 14521 diff changeset	1426 octave_idx_type n = args(2).int_value ();
e8e86ae3abbc make diag (x, m, n) return a proper diagonal matrix object (bug #36099) John W. Eaton <jwe@octave.org> parents: 14521 diff changeset	1427
12570 1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1428 if (! error_state)
14557 e8e86ae3abbc make diag (x, m, n) return a proper diagonal matrix object (bug #36099) John W. Eaton <jwe@octave.org> parents: 14521 diff changeset	1429 retval = arg0.diag (m, n);
12570 1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1430 else
1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1431 error ("diag: invalid dimensions");
1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1432 }
1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1433 else
1a93988610a3 Reverse changset cc8ccdfec424. Restore 3-input form of diag(). Rik <octave@nomad.inbox5.com> parents: 12567 diff changeset	1434 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	1435 }
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1436 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	1437 print_usage ();
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1438
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1439 return retval;
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1440 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1441
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1442 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1443
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1444 %!assert (full (diag ([1; 2; 3])), [1, 0, 0; 0, 2, 0; 0, 0, 3])
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1445 %!assert (diag ([1; 2; 3], 1), [0, 1, 0, 0; 0, 0, 2, 0; 0, 0, 0, 3; 0, 0, 0, 0])
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1446 %!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])
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1447 %!assert (diag ([1; 2; 3],-1), [0, 0, 0, 0; 1, 0, 0, 0; 0, 2, 0, 0; 0, 0, 3, 0])
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1448 %!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])
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1449
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1450 %!assert (diag ([1, 0, 0; 0, 2, 0; 0, 0, 3]), [1; 2; 3])
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1451 %!assert (diag ([0, 1, 0, 0; 0, 0, 2, 0; 0, 0, 0, 3; 0, 0, 0, 0], 1), [1; 2; 3])
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1452 %!assert (diag ([0, 0, 0, 0; 1, 0, 0, 0; 0, 2, 0, 0; 0, 0, 3, 0], -1), [1; 2; 3])
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1453 %!assert (diag (ones (1, 0), 2), zeros (2))
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1454 %!assert (diag (1:3, 4, 2), [1, 0; 0, 2; 0, 0; 0, 0])
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1455
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1456 %!assert (full (diag (single ([1; 2; 3]))), single ([1, 0, 0; 0, 2, 0; 0, 0, 3]))
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1457 %!assert (diag (single ([1; 2; 3]), 1), single ([0, 1, 0, 0; 0, 0, 2, 0; 0, 0, 0, 3; 0, 0, 0, 0]))
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1458 %!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]))
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1459 %!assert (diag (single ([1; 2; 3]),-1), single ([0, 0, 0, 0; 1, 0, 0, 0; 0, 2, 0, 0; 0, 0, 3, 0]))
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1460 %!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]))
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1461
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1462 %!assert (diag (single ([1, 0, 0; 0, 2, 0; 0, 0, 3])), single ([1; 2; 3]))
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1463 %!assert (diag (single ([0, 1, 0, 0; 0, 0, 2, 0; 0, 0, 0, 3; 0, 0, 0, 0]), 1), single ([1; 2; 3]))
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1464 %!assert (diag (single ([0, 0, 0, 0; 1, 0, 0, 0; 0, 2, 0, 0; 0, 0, 3, 0]), -1), single ([1; 2; 3]))
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1465
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1466 %!assert (diag (int8 ([1; 2; 3])), int8 ([1, 0, 0; 0, 2, 0; 0, 0, 3]))
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1467 %!assert (diag (int8 ([1; 2; 3]), 1), int8 ([0, 1, 0, 0; 0, 0, 2, 0; 0, 0, 0, 3; 0, 0, 0, 0]))
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1468 %!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]))
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1469 %!assert (diag (int8 ([1; 2; 3]),-1), int8 ([0, 0, 0, 0; 1, 0, 0, 0; 0, 2, 0, 0; 0, 0, 3, 0]))
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1470 %!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]))
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1471
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1472 %!assert (diag (int8 ([1, 0, 0; 0, 2, 0; 0, 0, 3])), int8 ([1; 2; 3]))
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1473 %!assert (diag (int8 ([0, 1, 0, 0; 0, 0, 2, 0; 0, 0, 0, 3; 0, 0, 0, 0]), 1), int8 ([1; 2; 3]))
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1474 %!assert (diag (int8 ([0, 0, 0, 0; 1, 0, 0, 0; 0, 2, 0, 0; 0, 0, 3, 0]), -1), int8 ([1; 2; 3]))
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1475
15428 fd5c0159b588 Fix diag handling of diagvectors (bug #37411) Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14567 diff changeset	1476 ## bug #37411
fd5c0159b588 Fix diag handling of diagvectors (bug #37411) Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14567 diff changeset	1477 %!assert (diag (diag ([5, 2, 3])(:,1)), diag([5 0 0 ]))
fd5c0159b588 Fix diag handling of diagvectors (bug #37411) Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14567 diff changeset	1478 %!assert (diag (diag ([5, 2, 3])(:,1), 2), [0 0 5 0 0; zeros(4, 5)])
fd5c0159b588 Fix diag handling of diagvectors (bug #37411) Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14567 diff changeset	1479 %!assert (diag (diag ([5, 2, 3])(:,1), -2), [[0 0 5 0 0]', zeros(5, 4)])
fd5c0159b588 Fix diag handling of diagvectors (bug #37411) Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14567 diff changeset	1480
14490 3959f3f81e33 Initialise memory in non-square diag call (bug #35946) Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14171 diff changeset	1481 ## Test non-square size
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	1482 %!assert (diag ([1,2,3], 6, 3), [1 0 0; 0 2 0; 0 0 3; 0 0 0; 0 0 0; 0 0 0])
14567 5bb5fcffa29d correctly fill cell arrays for three-arg diag function calls John W. Eaton <jwe@octave.org> parents: 14490 diff changeset	1483 %!assert (diag (1, 2, 3), [1,0,0; 0,0,0]);
5bb5fcffa29d correctly fill cell arrays for three-arg diag function calls John W. Eaton <jwe@octave.org> parents: 14490 diff changeset	1484 %!assert (diag ({1}, 2, 3), {1,[],[]; [],[],[]});
5bb5fcffa29d correctly fill cell arrays for three-arg diag function calls John W. Eaton <jwe@octave.org> parents: 14490 diff changeset	1485 %!assert (diag ({1,2}, 3, 4), {1,[],[],[]; [],2,[],[]; [],[],[],[]});
14490 3959f3f81e33 Initialise memory in non-square diag call (bug #35946) Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14171 diff changeset	1486
18145 a86d608c413c Return empty matrix rather than issuing error when requested diagonal is out of range. Marco Caliari <marco.caliari@univr.it> parents: 18111 diff changeset	1487 ## Test out-of-range diagonals
a86d608c413c Return empty matrix rather than issuing error when requested diagonal is out of range. Marco Caliari <marco.caliari@univr.it> parents: 18111 diff changeset	1488 %!assert (diag (ones (3,3), 4), zeros (0, 1))
a86d608c413c Return empty matrix rather than issuing error when requested diagonal is out of range. Marco Caliari <marco.caliari@univr.it> parents: 18111 diff changeset	1489 %!assert (diag (cell (3,3), 4), cell (0, 1))
a86d608c413c Return empty matrix rather than issuing error when requested diagonal is out of range. Marco Caliari <marco.caliari@univr.it> parents: 18111 diff changeset	1490 %!assert (diag (sparse (ones (3,3)), 4), sparse (zeros (0, 1)))
a86d608c413c Return empty matrix rather than issuing error when requested diagonal is out of range. Marco Caliari <marco.caliari@univr.it> parents: 18111 diff changeset	1491
12571 bed932910eb9 Add documentation for 3-input form of diag(). Add new tests. Rik <octave@nomad.inbox5.com> parents: 12570 diff changeset	1492 %% Test input validation
14491 5bd9e47e9277 maint: periodic merge of stable to default Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14429 14490 diff changeset	1493 %!error <Invalid call to diag> diag ()
5bd9e47e9277 maint: periodic merge of stable to default Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14429 14490 diff changeset	1494 %!error <Invalid call to diag> diag (1,2,3,4)
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1495 %!error diag (ones (2), 3, 3)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1496 %!error diag (1:3, -4, 3)
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1497
14557 e8e86ae3abbc make diag (x, m, n) return a proper diagonal matrix object (bug #36099) John W. Eaton <jwe@octave.org> parents: 14521 diff changeset	1498 %!assert (diag (1, 3, 3), diag ([1, 0, 0]))
e8e86ae3abbc make diag (x, m, n) return a proper diagonal matrix object (bug #36099) John W. Eaton <jwe@octave.org> parents: 14521 diff changeset	1499 %!assert (diag (i, 3, 3), diag ([i, 0, 0]))
e8e86ae3abbc make diag (x, m, n) return a proper diagonal matrix object (bug #36099) John W. Eaton <jwe@octave.org> parents: 14521 diff changeset	1500 %!assert (diag (single (1), 3, 3), diag ([single(1), 0, 0]))
e8e86ae3abbc make diag (x, m, n) return a proper diagonal matrix object (bug #36099) John W. Eaton <jwe@octave.org> parents: 14521 diff changeset	1501 %!assert (diag (single (i), 3, 3), diag ([single(i), 0, 0]))
e8e86ae3abbc make diag (x, m, n) return a proper diagonal matrix object (bug #36099) John W. Eaton <jwe@octave.org> parents: 14521 diff changeset	1502 %!assert (diag ([1, 2], 3, 3), diag ([1, 2, 0]))
e8e86ae3abbc make diag (x, m, n) return a proper diagonal matrix object (bug #36099) John W. Eaton <jwe@octave.org> parents: 14521 diff changeset	1503 %!assert (diag ([1, 2]i, 3, 3), diag ([1, 2, 0]i))
e8e86ae3abbc make diag (x, m, n) return a proper diagonal matrix object (bug #36099) John W. Eaton <jwe@octave.org> parents: 14521 diff changeset	1504 %!assert (diag (single ([1, 2]), 3, 3), diag (single ([1, 2, 0])))
e8e86ae3abbc make diag (x, m, n) return a proper diagonal matrix object (bug #36099) John W. Eaton <jwe@octave.org> parents: 14521 diff changeset	1505 %!assert (diag (single ([1, 2]i), 3, 3), diag (single ([1, 2, 0]i)))
e8e86ae3abbc make diag (x, m, n) return a proper diagonal matrix object (bug #36099) John W. Eaton <jwe@octave.org> parents: 14521 diff changeset	1506 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	1507
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	1508 DEFUN (prod, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1509 "-- texinfo --\n\
9163 9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	1510 @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	1511 @deftypefnx {Built-in Function} {} prod (@var{x}, @var{dim})\n\
18759 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1512 @deftypefnx {Built-in Function} {} prod (@dots{}, \"native\")\n\
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1513 @deftypefnx {Built-in Function} {} prod (@dots{}, \"double\")\n\
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1514 Product of elements along dimension @var{dim}.\n\
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1515 \n\
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1516 If @var{dim} is omitted, it defaults to the first non-singleton dimension.\n\
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1517 \n\
18851 9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 18850 diff changeset	1518 The optional @qcode{\"type\"} input determines the class of the variable\n\
9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 18850 diff changeset	1519 used for calculations. If the argument @qcode{\"native\"} is given, then\n\
9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 18850 diff changeset	1520 the operation is performed in the same type as the original argument, rather\n\
9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 18850 diff changeset	1521 than the default double type.\n\
18759 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1522 \n\
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1523 For example:\n\
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1524 \n\
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1525 @example\n\
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1526 @group\n\
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1527 prod ([true, true])\n\
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1528 @result{} 1\n\
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1529 prod ([true, true], \"native\")\n\
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1530 @result{} true\n\
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1531 @end group\n\
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1532 @end example\n\
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1533 \n\
18851 9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 18850 diff changeset	1534 On the contrary, if @qcode{\"double\"} is given, the operation is performed\n\
9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 18850 diff changeset	1535 in double precision even for single precision inputs.\n\
9163 9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	1536 @seealso{cumprod, sum}\n\
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	1537 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1538 {
18759 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1539 octave_value retval;
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1540
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1541 int nargin = args.length ();
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1542
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1543 bool isnative = false;
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1544 bool isdouble = false;
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1545
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1546 if (nargin > 1 && args(nargin - 1).is_string ())
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1547 {
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1548 std::string str = args(nargin - 1).string_value ();
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1549
19777 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	1550 if (str == "native")
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	1551 isnative = true;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	1552 else if (str == "double")
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	1553 isdouble = true;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	1554 else
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	1555 error ("prod: unrecognized type argument '%s'", str.c_str ());
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	1556 nargin --;
18759 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1557 }
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1558
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1559 if (error_state)
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1560 return retval;
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1561
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1562 if (nargin == 1 \|\| nargin == 2)
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1563 {
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1564 octave_value arg = args(0);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1565
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1566 int dim = -1;
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1567 if (nargin == 2)
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1568 {
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1569 dim = args(1).int_value () - 1;
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1570 if (dim < 0)
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1571 error ("prod: invalid dimension DIM = %d", dim + 1);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1572 }
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1573
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1574 if (! error_state)
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1575 {
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1576 switch (arg.builtin_type ())
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1577 {
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1578 case btyp_double:
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1579 if (arg.is_sparse_type ())
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1580 retval = arg.sparse_matrix_value ().prod (dim);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1581 else
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1582 retval = arg.array_value ().prod (dim);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1583 break;
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1584 case btyp_complex:
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1585 if (arg.is_sparse_type ())
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1586 retval = arg.sparse_complex_matrix_value ().prod (dim);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1587 else
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1588 retval = arg.complex_array_value ().prod (dim);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1589 break;
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1590 case btyp_float:
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1591 if (isdouble)
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1592 retval = arg.float_array_value ().dprod (dim);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1593 else
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1594 retval = arg.float_array_value ().prod (dim);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1595 break;
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1596 case btyp_float_complex:
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1597 if (isdouble)
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1598 retval = arg.float_complex_array_value ().dprod (dim);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1599 else
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1600 retval = arg.float_complex_array_value ().prod (dim);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1601 break;
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1602
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1603 #define MAKE_INT_BRANCH(X) \
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1604 case btyp_ ## X: \
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1605 if (isnative) \
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1606 retval = arg.X ## _array_value ().prod (dim); \
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1607 else \
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1608 retval = arg.array_value ().prod (dim); \
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1609 break;
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1610 MAKE_INT_BRANCH (int8);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1611 MAKE_INT_BRANCH (int16);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1612 MAKE_INT_BRANCH (int32);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1613 MAKE_INT_BRANCH (int64);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1614 MAKE_INT_BRANCH (uint8);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1615 MAKE_INT_BRANCH (uint16);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1616 MAKE_INT_BRANCH (uint32);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1617 MAKE_INT_BRANCH (uint64);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1618 #undef MAKE_INT_BRANCH
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1619
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1620 // GAGME: Accursed Matlab compatibility...
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1621 case btyp_char:
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1622 retval = arg.array_value (true).prod (dim);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1623 break;
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1624 case btyp_bool:
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1625 if (arg.is_sparse_type ())
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1626 {
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1627 if (isnative)
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1628 retval = arg.sparse_bool_matrix_value ().all (dim);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1629 else
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1630 retval = arg.sparse_matrix_value ().prod (dim);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1631 }
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1632 else if (isnative)
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1633 retval = arg.bool_array_value ().all (dim);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1634 else
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1635 retval = NDArray (arg.bool_array_value ().all (dim));
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1636 break;
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1637
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1638 default:
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1639 gripe_wrong_type_arg ("prod", arg);
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1640 }
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1641 }
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1642 }
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1643 else
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1644 print_usage ();
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1645
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1646 return retval;
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1647 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1648
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1649 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1650 %!assert (prod ([1, 2, 3]), 6)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1651 %!assert (prod ([-1; -2; -3]), -6)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1652 %!assert (prod ([i, 2+i, -3+2i, 4]), -4 - 32i)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1653 %!assert (prod ([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i]), [-1+i, -8+8i, -27+27i])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1654
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1655 %!assert (prod (single ([1, 2, 3])), single (6))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1656 %!assert (prod (single ([-1; -2; -3])), single (-6))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1657 %!assert (prod (single ([i, 2+i, -3+2i, 4])), single (-4 - 32i))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1658 %!assert (prod (single ([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i])), single ([-1+i, -8+8i, -27+27i]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1659
18759 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1660 %% Test sparse
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1661 %!assert (prod (sparse ([1, 2, 3])), sparse (6))
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1662 %!assert (prod (sparse ([-1; -2; -3])), sparse (-6))
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1663 ## Commented out until bug #42290 is fixed
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1664 #%!assert (prod (sparse ([i, 2+i, -3+2i, 4])), sparse (-4 - 32i))
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1665 #%!assert (prod (sparse ([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i])), sparse ([-1+i, -8+8i, -27+27i]))
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1666
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1667 %!assert (prod ([1, 2; 3, 4], 1), [3, 8])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1668 %!assert (prod ([1, 2; 3, 4], 2), [2; 12])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1669 %!assert (prod (zeros (1, 0)), 1)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1670 %!assert (prod (zeros (1, 0), 1), zeros (1, 0))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1671 %!assert (prod (zeros (1, 0), 2), 1)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1672 %!assert (prod (zeros (0, 1)), 1)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1673 %!assert (prod (zeros (0, 1), 1), 1)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1674 %!assert (prod (zeros (0, 1), 2), zeros (0, 1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1675 %!assert (prod (zeros (2, 0)), zeros (1, 0))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1676 %!assert (prod (zeros (2, 0), 1), zeros (1, 0))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1677 %!assert (prod (zeros (2, 0), 2), [1; 1])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1678 %!assert (prod (zeros (0, 2)), [1, 1])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1679 %!assert (prod (zeros (0, 2), 1), [1, 1])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1680 %!assert (prod (zeros (0, 2), 2), zeros (0, 1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1681
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1682 %!assert (prod (single ([1, 2; 3, 4]), 1), single ([3, 8]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1683 %!assert (prod (single ([1, 2; 3, 4]), 2), single ([2; 12]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1684 %!assert (prod (zeros (1, 0, "single")), single (1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1685 %!assert (prod (zeros (1, 0, "single"), 1), zeros (1, 0, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1686 %!assert (prod (zeros (1, 0, "single"), 2), single (1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1687 %!assert (prod (zeros (0, 1, "single")), single (1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1688 %!assert (prod (zeros (0, 1, "single"), 1), single (1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1689 %!assert (prod (zeros (0, 1, "single"), 2), zeros (0, 1, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1690 %!assert (prod (zeros (2, 0, "single")), zeros (1, 0, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1691 %!assert (prod (zeros (2, 0, "single"), 1), zeros (1, 0, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1692 %!assert (prod (zeros (2, 0, "single"), 2), single ([1; 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1693 %!assert (prod (zeros (0, 2, "single")), single ([1, 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1694 %!assert (prod (zeros (0, 2, "single"), 1), single ([1, 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1695 %!assert (prod (zeros (0, 2, "single"), 2), zeros (0, 1, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1696
18759 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1697 %% Test "double" type argument
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1698 %!assert (prod (single ([1, 2, 3]), "double"), 6)
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1699 %!assert (prod (single ([-1; -2; -3]), "double"), -6)
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1700 %!assert (prod (single ([i, 2+i, -3+2i, 4]), "double"), -4 - 32i)
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1701 %!assert (prod (single ([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i]), "double"), [-1+i, -8+8i, -27+27i])
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1702
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1703 %% Test "native" type argument
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1704 %!assert (prod (uint8 ([1, 2, 3]), "native"), uint8 (6))
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1705 %!assert (prod (uint8 ([-1; -2; -3]), "native"), uint8 (0))
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1706 %!assert (prod (int8 ([1, 2, 3]), "native"), int8 (6))
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1707 %!assert (prod (int8 ([-1; -2; -3]), "native"), int8 (-6))
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1708 %!assert (prod ([true false; true true], "native"), [true false])
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1709 %!assert (prod ([true false; true true], 2, "native"), [false; true])
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1710
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1711 %% Test input validation
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1712 %!error prod ()
18759 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1713 %!error prod (1,2,3)
8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	1714 %!error <unrecognized type argument 'foobar'> prod (1, "foobar")
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	1715 */
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1716
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1717 static bool
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1718 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	1719 {
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1720 int n_args = args.length ();
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1721 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	1722 if (args(i).numel () != 1)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1723 return false;
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1724
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1725 return true;
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1726 }
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1727
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1728 template <class TYPE, class T>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1729 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	1730 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	1731 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	1732 int dim)
f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1733 {
f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1734 int n_args = args.length ();
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1735 if (! (equal_types<T, char>::value
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1736 \|\| equal_types<T, octave_value>::value)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1737 && 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	1738 {
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1739 // Optimize all scalars case.
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1740 dim_vector dv (1, 1);
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1741 if (dim == -1 \|\| dim == -2)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1742 dim = -dim - 1;
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1743 else if (dim >= 2)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1744 dv.resize (dim+1, 1);
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1745 dv(dim) = n_args;
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1746
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1747 result.clear (dv);
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1748
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1749 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	1750 {
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1751 octave_quit ();
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1752
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1753 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	1754 }
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1755 }
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1756 else
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1757 {
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1758 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	1759
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1760 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	1761 {
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1762 octave_quit ();
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1763
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1764 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	1765 }
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1766
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1767 if (! error_state)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1768 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	1769 }
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1770 }
f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1771
f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1772 template <class TYPE, class T>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1773 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	1774 single_type_concat (Sparse<T>& result,
10498 8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1775 const octave_value_list& args,
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1776 int dim)
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1777 {
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1778 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	1779 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	1780
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1781 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	1782 {
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1783 octave_quit ();
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1784
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1785 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	1786 }
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1787
f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1788 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	1789 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	1790 }
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1791
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1792 // Dispatcher.
10498 8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1793 template<class TYPE>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1794 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	1795 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	1796 {
10533 f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1797 TYPE result;
f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1798
f094ac9bc93e reuse Array<T>::cat and Sparse<T>::cat in cat/horzcat/vertcat Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	1799 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	1800
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1801 return result;
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1802 }
8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10436 diff changeset	1803
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1804 template<class MAP>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1805 static void
10758 f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1806 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	1807 const octave_value_list& args,
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1808 int dim)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1809 {
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1810 int n_args = args.length ();
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1811 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	1812
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1813 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	1814 {
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1815 octave_quit ();
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1816
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1817 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	1818 }
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1819
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1820 if (! error_state)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1821 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	1822 }
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1823
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1824 static octave_map
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1825 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	1826 int dim)
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1827 {
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1828 octave_map result;
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1829 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	1830 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	1831 else
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1832 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	1833
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1834 return result;
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1835 }
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	1836
4824 4829055e154f [project @ 2004-03-08 18:16:04 by jwe] jwe parents: 4806 diff changeset	1837 static octave_value
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1838 attempt_type_conversion (const octave_value& ov, std::string dtype)
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1839 {
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1840 octave_value retval;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1841
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1842 // First try to find function in the class of OV that can convert to
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1843 // the dispatch type dtype. It will have the name of the dispatch
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1844 // type.
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1845
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1846 std::string cname = ov.class_name ();
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1847
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1848 octave_value fcn = symbol_table::find_method (dtype, cname);
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1849
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1850 if (fcn.is_defined ())
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1851 {
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1852 octave_value_list result
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1853 = fcn.do_multi_index_op (1, octave_value_list (1, ov));
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1854
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1855 if (! error_state && result.length () > 0)
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1856 retval = result(0);
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1857 else
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1858 error ("conversion from %s to %s failed", dtype.c_str (),
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1859 cname.c_str ());
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1860 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1861 else
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1862 {
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1863 // No conversion function available. Try the constructor for the
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1864 // dispatch type.
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1865
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1866 fcn = symbol_table::find_method (dtype, dtype);
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1867
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1868 if (fcn.is_defined ())
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1869 {
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1870 octave_value_list result
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1871 = fcn.do_multi_index_op (1, octave_value_list (1, ov));
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1872
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1873 if (! error_state && result.length () > 0)
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1874 retval = result(0);
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1875 else
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1876 error ("%s constructor failed for %s argument", dtype.c_str (),
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1877 cname.c_str ());
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1878 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1879 else
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1880 error ("no constructor for %s!", dtype.c_str ());
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1881 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1882
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1883 return retval;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1884 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1885
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1886 octave_value
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1887 do_class_concat (const octave_value_list& ovl, std::string cattype, int dim)
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1888 {
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1889 octave_value retval;
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1890
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1891 // Get dominant type for list
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1892
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1893 std::string dtype = get_dispatch_type (ovl);
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1894
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1895 octave_value fcn = symbol_table::find_method (cattype, dtype);
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1896
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1897 if (fcn.is_defined ())
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1898 {
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1899 // Have method for dominant type, so call it and let it handle
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1900 // conversions.
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1901
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1902 octave_value_list tmp2 = fcn.do_multi_index_op (1, ovl);
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1903
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1904 if (! error_state)
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1905 {
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1906 if (tmp2.length () > 0)
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1907 retval = tmp2(0);
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1908 else
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1909 {
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1910 error ("%s/%s method did not return a value",
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1911 dtype.c_str (), cattype.c_str ());
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1912 goto done;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1913 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1914 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1915 else
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1916 goto done;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1917 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1918 else
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1919 {
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1920 // No method for dominant type, so attempt type conversions for
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1921 // all elements that are not of the dominant type, then do the
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1922 // default operation for octave_class values.
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1923
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1924 octave_idx_type j = 0;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1925 octave_idx_type len = ovl.length ();
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1926 octave_value_list tmp (len, octave_value ());
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1927 for (octave_idx_type k = 0; k < len; k++)
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1928 {
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1929 octave_value elt = ovl(k);
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1930
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1931 std::string t1_type = elt.class_name ();
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1932
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1933 if (t1_type == dtype)
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1934 tmp(j++) = elt;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1935 else if (elt.is_object () \|\| ! elt.is_empty ())
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1936 {
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1937 tmp(j++) = attempt_type_conversion (elt, dtype);
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1938
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1939 if (error_state)
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1940 goto done;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1941 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1942 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1943
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1944 tmp.resize (j);
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1945
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1946 octave_map m = do_single_type_concat_map (tmp, dim);
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1947
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1948 std::string cname = tmp(0).class_name ();
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1949 std::list<std::string> parents = tmp(0).parent_class_name_list ();
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1950
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1951 retval = octave_value (new octave_class (m, cname, parents));
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1952 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1953
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1954 done:
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1955 return retval;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1956 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1957
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1958 static octave_value
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1959 do_cat (const octave_value_list& xargs, int dim, std::string fname)
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1960 {
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1961 octave_value retval;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1962
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1963 // We may need to convert elements of the list to cells, so make a
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1964 // copy. This should be efficient, it is done mostly by incrementing
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1965 // reference counts.
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1966 octave_value_list args = xargs;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1967
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	1968 int n_args = args.length ();
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	1969
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1970 if (n_args == 0)
5714 24f6a13878c2 [project @ 2006-03-23 21:46:09 by jwe] jwe parents: 5677 diff changeset	1971 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	1972 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	1973 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	1974 else if (n_args > 1)
4824 4829055e154f [project @ 2004-03-08 18:16:04 by jwe] jwe parents: 4806 diff changeset	1975 {
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1976 std::string result_type;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1977
19433 2304ddfd736f Restore warning Octave:num-to-str missing since 3.2.4 (bug #43814). Rik <rik@octave.org> parents: 18903 diff changeset	1978 bool all_strings_p = true;
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1979 bool all_sq_strings_p = true;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1980 bool all_dq_strings_p = true;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1981 bool all_real_p = true;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1982 bool all_cmplx_p = true;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1983 bool any_sparse_p = false;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1984 bool any_cell_p = false;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1985 bool any_class_p = false;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1986
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1987 bool first_elem_is_struct = false;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1988
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1989 for (int i = 0; i < n_args; i++)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	1990 {
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1991 if (i == 0)
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1992 {
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1993 result_type = args(i).class_name ();
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1994
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1995 first_elem_is_struct = args(i).is_map ();
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1996 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1997 else
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	1998 result_type = get_concat_class (result_type, args(i).class_name ());
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	1999
19433 2304ddfd736f Restore warning Octave:num-to-str missing since 3.2.4 (bug #43814). Rik <rik@octave.org> parents: 18903 diff changeset	2000 if (all_strings_p && ! args(i).is_string ())
2304ddfd736f Restore warning Octave:num-to-str missing since 3.2.4 (bug #43814). Rik <rik@octave.org> parents: 18903 diff changeset	2001 all_strings_p = false;
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2002 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	2003 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	2004 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	2005 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	2006 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	2007 all_real_p = false;
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2008 if (all_cmplx_p && ! (args(i).is_complex_type ()
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2009 \|\| args(i).is_real_type ()))
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2010 all_cmplx_p = false;
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2011 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	2012 any_sparse_p = true;
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2013 if (!any_cell_p && args(i).is_cell ())
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2014 any_cell_p = true;
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2015 if (!any_class_p && args(i).is_object ())
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2016 any_class_p = true;
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2017 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2018
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2019 if (any_cell_p && ! any_class_p && ! first_elem_is_struct)
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2020 {
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2021 for (int i = 0; i < n_args; i++)
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2022 {
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2023 if (! args(i).is_cell ())
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2024 args(i) = Cell (args(i));
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2025 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2026 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2027
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2028 if (any_class_p)
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2029 {
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2030 retval = do_class_concat (args, fname, dim);
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2031 }
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2032 else if (result_type == "double")
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2033 {
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2034 if (any_sparse_p)
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	2035 {
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2036 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	2037 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	2038 else
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2039 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	2040 }
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2041 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2042 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2043 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	2044 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	2045 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	2046 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	2047 }
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2048 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2049 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	2050 {
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2051 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	2052 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	2053 else
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2054 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	2055 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2056 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	2057 {
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2058 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	2059
19433 2304ddfd736f Restore warning Octave:num-to-str missing since 3.2.4 (bug #43814). Rik <rik@octave.org> parents: 18903 diff changeset	2060 if (! all_strings_p)
2304ddfd736f Restore warning Octave:num-to-str missing since 3.2.4 (bug #43814). Rik <rik@octave.org> parents: 18903 diff changeset	2061 gripe_implicit_conversion ("Octave:num-to-str",
2304ddfd736f Restore warning Octave:num-to-str missing since 3.2.4 (bug #43814). Rik <rik@octave.org> parents: 18903 diff changeset	2062 "numeric", result_type);
2304ddfd736f Restore warning Octave:num-to-str missing since 3.2.4 (bug #43814). Rik <rik@octave.org> parents: 18903 diff changeset	2063 else
2304ddfd736f Restore warning Octave:num-to-str missing since 3.2.4 (bug #43814). Rik <rik@octave.org> parents: 18903 diff changeset	2064 maybe_warn_string_concat (all_dq_strings_p, all_sq_strings_p);
2304ddfd736f Restore warning Octave:num-to-str missing since 3.2.4 (bug #43814). Rik <rik@octave.org> parents: 18903 diff changeset	2065
2304ddfd736f Restore warning Octave:num-to-str missing since 3.2.4 (bug #43814). Rik <rik@octave.org> parents: 18903 diff changeset	2066 charNDArray result = do_single_type_concat<charNDArray> (args, dim);
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2067
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2068 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	2069 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2070 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	2071 {
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2072 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	2073 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	2074 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	2075 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	2076 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2077 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	2078 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	2079 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	2080 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	2081 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	2082 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	2083 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	2084 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	2085 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	2086 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	2087 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	2088 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	2089 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	2090 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	2091 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	2092 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	2093 else if (result_type == "cell")
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	2094 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	2095 else if (result_type == "struct")
f3892d8eea9f optimize horzcat/vertcat for scalars, cells and structs Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	2096 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	2097 else
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2098 {
20253 b2100e1659ac maint: Use cuddled parentheses when indexing dimension_vectors. Rik <rik@octave.org> parents: 20218 diff changeset	2099 dim_vector dv = args(0).dims ();
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2100
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2101 // Default concatenation.
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2102 bool (dim_vector::*concat_rule) (const dim_vector&, int)
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2103 = &dim_vector::concat;
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2104
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2105 if (dim == -1 \|\| dim == -2)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2106 {
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2107 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	2108 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	2109 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2110
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2111 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	2112 {
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2113 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	2114 {
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	2115 // 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	2116 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	2117 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	2118 }
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2119 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2120
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2121 // 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	2122 // 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	2123 // 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	2124 // 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	2125 // 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	2126 // 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	2127 // 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	2128 //
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2129 // 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	2130 // 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	2131 // (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	2132 // 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	2133 // 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	2134
18111 b560bac0fca2 maint: Don't use space between 'args' and '(' when doing indexing. Rik <rik@octave.org> parents: 18099 diff changeset	2135 octave_value tmp = args(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	2136 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	2137
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2138 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	2139 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	2140
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2141 int dv_len = dv.length ();
11570 57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	2142 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	2143
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2144 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	2145 {
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2146 // Can't fast return here to skip empty matrices as something
14861 f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory Rik <octave@nomad.inbox5.com> parents: 14853 diff changeset	2147 // like cat (1,[],single ([])) must return an empty matrix of
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2148 // the right type.
18111 b560bac0fca2 maint: Don't use space between 'args' and '(' when doing indexing. Rik <rik@octave.org> parents: 18099 diff changeset	2149 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	2150
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2151 if (error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2152 return retval;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2153
18111 b560bac0fca2 maint: Don't use space between 'args' and '(' when doing indexing. Rik <rik@octave.org> parents: 18099 diff changeset	2154 dim_vector dv_tmp = args(j).dims ();
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2155
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2156 if (dim >= dv_len)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2157 {
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2158 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	2159 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	2160 break;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2161 }
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2162 else
20253 b2100e1659ac maint: Use cuddled parentheses when indexing dimension_vectors. Rik <rik@octave.org> parents: 20218 diff changeset	2163 ra_idx(dim) += (dim < dv_tmp.length () ? dv_tmp(dim) : 1);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2164 }
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2165 retval = tmp;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2166 }
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2167 }
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2168 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2169 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	2170
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2171 return retval;
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2172 }
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2173
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2174 DEFUN (horzcat, args, ,
4824 4829055e154f [project @ 2004-03-08 18:16:04 by jwe] jwe parents: 4806 diff changeset	2175 "-- texinfo --\n\
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2176 @deftypefn {Built-in Function} {} horzcat (@var{array1}, @var{array2}, @dots{}, @var{arrayN})\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	2177 Return the horizontal concatenation of N-D array objects, @var{array1},\n\
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2178 @var{array2}, @dots{}, @var{arrayN} along dimension 2.\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	2179 \n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	2180 Arrays may also be concatenated horizontally using the syntax for creating\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	2181 new matrices. For example:\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	2182 \n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	2183 @example\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2184 @var{hcat} = [ @var{array1}, @var{array2}, @dots{} ]\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	2185 @end example\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5607 diff changeset	2186 @seealso{cat, vertcat}\n\
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5607 diff changeset	2187 @end deftypefn")
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2188 {
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2189 return do_cat (args, -2, "horzcat");
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2190 }
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2191
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2192 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2193 ## Test concatenation with all zero matrices
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2194 %!assert (horzcat ("", 65*ones (1,10)), "AAAAAAAAAA");
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2195 %!assert (horzcat (65*ones (1,10), ""), "AAAAAAAAAA");
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2196
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2197 %!assert (class (horzcat (int64 (1), int64 (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2198 %!assert (class (horzcat (int64 (1), int32 (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2199 %!assert (class (horzcat (int64 (1), int16 (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2200 %!assert (class (horzcat (int64 (1), int8 (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2201 %!assert (class (horzcat (int64 (1), uint64 (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2202 %!assert (class (horzcat (int64 (1), uint32 (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2203 %!assert (class (horzcat (int64 (1), uint16 (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2204 %!assert (class (horzcat (int64 (1), uint8 (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2205 %!assert (class (horzcat (int64 (1), single (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2206 %!assert (class (horzcat (int64 (1), double (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2207 %!assert (class (horzcat (int64 (1), cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2208 %!assert (class (horzcat (int64 (1), true)), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2209 %!assert (class (horzcat (int64 (1), "a")), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2210
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2211 %!assert (class (horzcat (int32 (1), int64 (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2212 %!assert (class (horzcat (int32 (1), int32 (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2213 %!assert (class (horzcat (int32 (1), int16 (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2214 %!assert (class (horzcat (int32 (1), int8 (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2215 %!assert (class (horzcat (int32 (1), uint64 (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2216 %!assert (class (horzcat (int32 (1), uint32 (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2217 %!assert (class (horzcat (int32 (1), uint16 (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2218 %!assert (class (horzcat (int32 (1), uint8 (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2219 %!assert (class (horzcat (int32 (1), single (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2220 %!assert (class (horzcat (int32 (1), double (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2221 %!assert (class (horzcat (int32 (1), cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2222 %!assert (class (horzcat (int32 (1), true)), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2223 %!assert (class (horzcat (int32 (1), "a")), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2224
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2225 %!assert (class (horzcat (int16 (1), int64 (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2226 %!assert (class (horzcat (int16 (1), int32 (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2227 %!assert (class (horzcat (int16 (1), int16 (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2228 %!assert (class (horzcat (int16 (1), int8 (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2229 %!assert (class (horzcat (int16 (1), uint64 (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2230 %!assert (class (horzcat (int16 (1), uint32 (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2231 %!assert (class (horzcat (int16 (1), uint16 (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2232 %!assert (class (horzcat (int16 (1), uint8 (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2233 %!assert (class (horzcat (int16 (1), single (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2234 %!assert (class (horzcat (int16 (1), double (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2235 %!assert (class (horzcat (int16 (1), cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2236 %!assert (class (horzcat (int16 (1), true)), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2237 %!assert (class (horzcat (int16 (1), "a")), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2238
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2239 %!assert (class (horzcat (int8 (1), int64 (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2240 %!assert (class (horzcat (int8 (1), int32 (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2241 %!assert (class (horzcat (int8 (1), int16 (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2242 %!assert (class (horzcat (int8 (1), int8 (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2243 %!assert (class (horzcat (int8 (1), uint64 (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2244 %!assert (class (horzcat (int8 (1), uint32 (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2245 %!assert (class (horzcat (int8 (1), uint16 (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2246 %!assert (class (horzcat (int8 (1), uint8 (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2247 %!assert (class (horzcat (int8 (1), single (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2248 %!assert (class (horzcat (int8 (1), double (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2249 %!assert (class (horzcat (int8 (1), cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2250 %!assert (class (horzcat (int8 (1), true)), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2251 %!assert (class (horzcat (int8 (1), "a")), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2252
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2253 %!assert (class (horzcat (uint64 (1), int64 (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2254 %!assert (class (horzcat (uint64 (1), int32 (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2255 %!assert (class (horzcat (uint64 (1), int16 (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2256 %!assert (class (horzcat (uint64 (1), int8 (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2257 %!assert (class (horzcat (uint64 (1), uint64 (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2258 %!assert (class (horzcat (uint64 (1), uint32 (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2259 %!assert (class (horzcat (uint64 (1), uint16 (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2260 %!assert (class (horzcat (uint64 (1), uint8 (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2261 %!assert (class (horzcat (uint64 (1), single (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2262 %!assert (class (horzcat (uint64 (1), double (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2263 %!assert (class (horzcat (uint64 (1), cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2264 %!assert (class (horzcat (uint64 (1), true)), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2265 %!assert (class (horzcat (uint64 (1), "a")), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2266
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2267 %!assert (class (horzcat (uint32 (1), int64 (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2268 %!assert (class (horzcat (uint32 (1), int32 (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2269 %!assert (class (horzcat (uint32 (1), int16 (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2270 %!assert (class (horzcat (uint32 (1), int8 (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2271 %!assert (class (horzcat (uint32 (1), uint64 (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2272 %!assert (class (horzcat (uint32 (1), uint32 (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2273 %!assert (class (horzcat (uint32 (1), uint16 (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2274 %!assert (class (horzcat (uint32 (1), uint8 (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2275 %!assert (class (horzcat (uint32 (1), single (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2276 %!assert (class (horzcat (uint32 (1), double (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2277 %!assert (class (horzcat (uint32 (1), cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2278 %!assert (class (horzcat (uint32 (1), true)), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2279 %!assert (class (horzcat (uint32 (1), "a")), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2280
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2281 %!assert (class (horzcat (uint16 (1), int64 (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2282 %!assert (class (horzcat (uint16 (1), int32 (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2283 %!assert (class (horzcat (uint16 (1), int16 (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2284 %!assert (class (horzcat (uint16 (1), int8 (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2285 %!assert (class (horzcat (uint16 (1), uint64 (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2286 %!assert (class (horzcat (uint16 (1), uint32 (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2287 %!assert (class (horzcat (uint16 (1), uint16 (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2288 %!assert (class (horzcat (uint16 (1), uint8 (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2289 %!assert (class (horzcat (uint16 (1), single (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2290 %!assert (class (horzcat (uint16 (1), double (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2291 %!assert (class (horzcat (uint16 (1), cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2292 %!assert (class (horzcat (uint16 (1), true)), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2293 %!assert (class (horzcat (uint16 (1), "a")), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2294
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2295 %!assert (class (horzcat (uint8 (1), int64 (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2296 %!assert (class (horzcat (uint8 (1), int32 (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2297 %!assert (class (horzcat (uint8 (1), int16 (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2298 %!assert (class (horzcat (uint8 (1), int8 (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2299 %!assert (class (horzcat (uint8 (1), uint64 (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2300 %!assert (class (horzcat (uint8 (1), uint32 (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2301 %!assert (class (horzcat (uint8 (1), uint16 (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2302 %!assert (class (horzcat (uint8 (1), uint8 (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2303 %!assert (class (horzcat (uint8 (1), single (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2304 %!assert (class (horzcat (uint8 (1), double (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2305 %!assert (class (horzcat (uint8 (1), cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2306 %!assert (class (horzcat (uint8 (1), true)), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2307 %!assert (class (horzcat (uint8 (1), "a")), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2308
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2309 %!assert (class (horzcat (single (1), int64 (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2310 %!assert (class (horzcat (single (1), int32 (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2311 %!assert (class (horzcat (single (1), int16 (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2312 %!assert (class (horzcat (single (1), int8 (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2313 %!assert (class (horzcat (single (1), uint64 (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2314 %!assert (class (horzcat (single (1), uint32 (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2315 %!assert (class (horzcat (single (1), uint16 (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2316 %!assert (class (horzcat (single (1), uint8 (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2317 %!assert (class (horzcat (single (1), single (1))), "single")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2318 %!assert (class (horzcat (single (1), double (1))), "single")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2319 %!assert (class (horzcat (single (1), cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2320 %!assert (class (horzcat (single (1), true)), "single")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2321 %!assert (class (horzcat (single (1), "a")), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2322
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2323 %!assert (class (horzcat (double (1), int64 (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2324 %!assert (class (horzcat (double (1), int32 (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2325 %!assert (class (horzcat (double (1), int16 (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2326 %!assert (class (horzcat (double (1), int8 (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2327 %!assert (class (horzcat (double (1), uint64 (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2328 %!assert (class (horzcat (double (1), uint32 (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2329 %!assert (class (horzcat (double (1), uint16 (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2330 %!assert (class (horzcat (double (1), uint8 (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2331 %!assert (class (horzcat (double (1), single (1))), "single")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2332 %!assert (class (horzcat (double (1), double (1))), "double")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2333 %!assert (class (horzcat (double (1), cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2334 %!assert (class (horzcat (double (1), true)), "double")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2335 %!assert (class (horzcat (double (1), "a")), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2336
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2337 %!assert (class (horzcat (cell (1), int64 (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2338 %!assert (class (horzcat (cell (1), int32 (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2339 %!assert (class (horzcat (cell (1), int16 (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2340 %!assert (class (horzcat (cell (1), int8 (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2341 %!assert (class (horzcat (cell (1), uint64 (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2342 %!assert (class (horzcat (cell (1), uint32 (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2343 %!assert (class (horzcat (cell (1), uint16 (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2344 %!assert (class (horzcat (cell (1), uint8 (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2345 %!assert (class (horzcat (cell (1), single (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2346 %!assert (class (horzcat (cell (1), double (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2347 %!assert (class (horzcat (cell (1), cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2348 %!assert (class (horzcat (cell (1), true)), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2349 %!assert (class (horzcat (cell (1), "a")), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2350
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2351 %!assert (class (horzcat (true, int64 (1))), "int64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2352 %!assert (class (horzcat (true, int32 (1))), "int32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2353 %!assert (class (horzcat (true, int16 (1))), "int16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2354 %!assert (class (horzcat (true, int8 (1))), "int8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2355 %!assert (class (horzcat (true, uint64 (1))), "uint64")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2356 %!assert (class (horzcat (true, uint32 (1))), "uint32")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2357 %!assert (class (horzcat (true, uint16 (1))), "uint16")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2358 %!assert (class (horzcat (true, uint8 (1))), "uint8")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2359 %!assert (class (horzcat (true, single (1))), "single")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2360 %!assert (class (horzcat (true, double (1))), "double")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2361 %!assert (class (horzcat (true, cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2362 %!assert (class (horzcat (true, true)), "logical")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2363 %!assert (class (horzcat (true, "a")), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2364
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2365 %!assert (class (horzcat ("a", int64 (1))), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2366 %!assert (class (horzcat ("a", int32 (1))), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2367 %!assert (class (horzcat ("a", int16 (1))), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2368 %!assert (class (horzcat ("a", int8 (1))), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2369 %!assert (class (horzcat ("a", int64 (1))), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2370 %!assert (class (horzcat ("a", int32 (1))), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2371 %!assert (class (horzcat ("a", int16 (1))), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2372 %!assert (class (horzcat ("a", int8 (1))), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2373 %!assert (class (horzcat ("a", single (1))), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2374 %!assert (class (horzcat ("a", double (1))), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2375 %!assert (class (horzcat ("a", cell (1))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2376 %!assert (class (horzcat ("a", true)), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2377 %!assert (class (horzcat ("a", "a")), "char")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2378
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2379 %!assert (class (horzcat (cell (1), struct ("foo", "bar"))), "cell")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2380
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2381 %!error horzcat (struct ("foo", "bar"), cell (1))
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2382 */
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2383
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2384 DEFUN (vertcat, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2385 "-- texinfo --\n\
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2386 @deftypefn {Built-in Function} {} vertcat (@var{array1}, @var{array2}, @dots{}, @var{arrayN})\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	2387 Return the vertical concatenation of N-D array objects, @var{array1},\n\
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2388 @var{array2}, @dots{}, @var{arrayN} along dimension 1.\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	2389 \n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	2390 Arrays may also be concatenated vertically using the syntax for creating\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	2391 new matrices. For example:\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	2392 \n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	2393 @example\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2394 @var{vcat} = [ @var{array1}; @var{array2}; @dots{} ]\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	2395 @end example\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5607 diff changeset	2396 @seealso{cat, horzcat}\n\
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5607 diff changeset	2397 @end deftypefn")
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2398 {
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2399 return do_cat (args, -1, "vertcat");
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2400 }
d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2401
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2402 /*
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2403 %!test
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2404 %! c = {"foo"; "bar"; "bazoloa"};
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2405 %! assert (vertcat (c, "a", "bc", "def"), {"foo"; "bar"; "bazoloa"; "a"; "bc"; "def"});
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2406 */
7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13029 diff changeset	2407
4758 a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2408 DEFUN (cat, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2409 "-- texinfo --\n\
4758 a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2410 @deftypefn {Built-in Function} {} cat (@var{dim}, @var{array1}, @var{array2}, @dots{}, @var{arrayN})\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	2411 Return the concatenation of N-D array objects, @var{array1},\n\
4806 d3bd9c04147f [project @ 2004-03-02 05:12:32 by jwe] jwe parents: 4768 diff changeset	2412 @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	2413 \n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2414 @example\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2415 @group\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2416 A = ones (2, 2);\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2417 B = zeros (2, 2);\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2418 cat (2, A, B)\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2419 @result{} 1 1 0 0\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2420 1 1 0 0\n\
4758 a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2421 @end group\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2422 @end example\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2423 \n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2424 Alternatively, we can concatenate @var{A} and @var{B} along the\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2425 second dimension in the following way:\n\
4758 a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2426 \n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2427 @example\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2428 @group\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2429 [A, B]\n\
4758 a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2430 @end group\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2431 @end example\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2432 \n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	2433 @var{dim} can be larger than the dimensions of the N-D array objects\n\
4758 a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2434 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	2435 following example shows:\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	2436 \n\
4758 a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2437 @example\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2438 @group\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	2439 cat (4, ones (2, 2), zeros (2, 2))\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2440 @result{} ans(:,:,1,1) =\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2441 \n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2442 1 1\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2443 1 1\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2444 \n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2445 ans(:,:,1,2) =\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2446 \n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2447 0 0\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2448 0 0\n\
4758 a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2449 @end group\n\
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2450 @end example\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5607 diff changeset	2451 @seealso{horzcat, vertcat}\n\
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5607 diff changeset	2452 @end deftypefn")
4758 a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2453 {
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2454 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	2455
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2456 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	2457 {
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2458 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	2459
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2460 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	2461 {
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2462 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	2463 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	2464 else
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	2465 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	2466 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2467 else
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	2468 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	2469 }
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2470 else
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2471 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	2472
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10711 diff changeset	2473 return retval;
4758 a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2474 }
a308566c8b42 [project @ 2004-02-13 23:01:34 by jwe] jwe parents: 4741 diff changeset	2475
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	2476 /*
14085 4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2477 %!function ret = __testcat (t1, t2, tr, cmplx)
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	2478 %! assert (cat (1, cast ([], t1), cast ([], t2)), cast ([], tr));
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2479 %!
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2480 %! assert (cat (1, cast (1, t1), cast (2, t2)), cast ([1; 2], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2481 %! assert (cat (1, cast (1, t1), cast ([2; 3], t2)), cast ([1; 2; 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2482 %! assert (cat (1, cast ([1; 2], t1), cast (3, t2)), cast ([1; 2; 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2483 %! assert (cat (1, cast ([1; 2], t1), cast ([3; 4], t2)), cast ([1; 2; 3; 4], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2484 %! assert (cat (2, cast (1, t1), cast (2, t2)), cast ([1, 2], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2485 %! assert (cat (2, cast (1, t1), cast ([2, 3], t2)), cast ([1, 2, 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2486 %! assert (cat (2, cast ([1, 2], t1), cast (3, t2)), cast ([1, 2, 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2487 %! assert (cat (2, cast ([1, 2], t1), cast ([3, 4], t2)), cast ([1, 2, 3, 4], tr));
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2488 %!
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2489 %! assert ([cast(1, t1); cast(2, t2)], cast ([1; 2], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2490 %! assert ([cast(1, t1); cast([2; 3], t2)], cast ([1; 2; 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2491 %! assert ([cast([1; 2], t1); cast(3, t2)], cast ([1; 2; 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2492 %! assert ([cast([1; 2], t1); cast([3; 4], t2)], cast ([1; 2; 3; 4], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2493 %! assert ([cast(1, t1), cast(2, t2)], cast ([1, 2], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2494 %! assert ([cast(1, t1), cast([2, 3], t2)], cast ([1, 2, 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2495 %! assert ([cast([1, 2], t1), cast(3, t2)], cast ([1, 2, 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2496 %! assert ([cast([1, 2], t1), cast([3, 4], t2)], cast ([1, 2, 3, 4], tr));
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2497 %!
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2498 %! if (nargin == 3 \|\| cmplx)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2499 %! assert (cat (1, cast (1i, t1), cast (2, t2)), cast ([1i; 2], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2500 %! assert (cat (1, cast (1i, t1), cast ([2; 3], t2)), cast ([1i; 2; 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2501 %! assert (cat (1, cast ([1i; 2], t1), cast (3, t2)), cast ([1i; 2; 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2502 %! assert (cat (1, cast ([1i; 2], t1), cast ([3; 4], t2)), cast ([1i; 2; 3; 4], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2503 %! assert (cat (2, cast (1i, t1), cast (2, t2)), cast ([1i, 2], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2504 %! assert (cat (2, cast (1i, t1), cast ([2, 3], t2)), cast ([1i, 2, 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2505 %! assert (cat (2, cast ([1i, 2], t1), cast (3, t2)), cast ([1i, 2, 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2506 %! assert (cat (2, cast ([1i, 2], t1), cast ([3, 4], t2)), cast ([1i, 2, 3, 4], tr));
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2507 %!
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2508 %! assert ([cast(1i, t1); cast(2, t2)], cast ([1i; 2], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2509 %! assert ([cast(1i, t1); cast([2; 3], t2)], cast ([1i; 2; 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2510 %! assert ([cast([1i; 2], t1); cast(3, t2)], cast ([1i; 2; 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2511 %! assert ([cast([1i; 2], t1); cast([3; 4], t2)], cast ([1i; 2; 3; 4], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2512 %! assert ([cast(1i, t1), cast(2, t2)], cast ([1i, 2], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2513 %! assert ([cast(1i, t1), cast([2, 3], t2)], cast ([1i, 2, 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2514 %! assert ([cast([1i, 2], t1), cast(3, t2)], cast ([1i, 2, 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2515 %! assert ([cast([1i, 2], t1), cast([3, 4], t2)], cast ([1i, 2, 3, 4], tr));
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2516 %!
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2517 %! assert (cat (1, cast (1, t1), cast (2i, t2)), cast ([1; 2i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2518 %! assert (cat (1, cast (1, t1), cast ([2i; 3], t2)), cast ([1; 2i; 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2519 %! assert (cat (1, cast ([1; 2], t1), cast (3i, t2)), cast ([1; 2; 3i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2520 %! assert (cat (1, cast ([1; 2], t1), cast ([3i; 4], t2)), cast ([1; 2; 3i; 4], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2521 %! assert (cat (2, cast (1, t1), cast (2i, t2)), cast ([1, 2i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2522 %! assert (cat (2, cast (1, t1), cast ([2i, 3], t2)), cast ([1, 2i, 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2523 %! assert (cat (2, cast ([1, 2], t1), cast (3i, t2)), cast ([1, 2, 3i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2524 %! assert (cat (2, cast ([1, 2], t1), cast ([3i, 4], t2)), cast ([1, 2, 3i, 4], tr));
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2525 %!
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2526 %! assert ([cast(1, t1); cast(2i, t2)], cast ([1; 2i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2527 %! assert ([cast(1, t1); cast([2i; 3], t2)], cast ([1; 2i; 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2528 %! assert ([cast([1; 2], t1); cast(3i, t2)], cast ([1; 2; 3i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2529 %! assert ([cast([1; 2], t1); cast([3i; 4], t2)], cast ([1; 2; 3i; 4], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2530 %! assert ([cast(1, t1), cast(2i, t2)], cast ([1, 2i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2531 %! assert ([cast(1, t1), cast([2i, 3], t2)], cast ([1, 2i, 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2532 %! assert ([cast([1, 2], t1), cast(3i, t2)], cast ([1, 2, 3i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2533 %! assert ([cast([1, 2], t1), cast([3i, 4], t2)], cast ([1, 2, 3i, 4], tr));
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2534 %!
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2535 %! assert (cat (1, cast (1i, t1), cast (2i, t2)), cast ([1i; 2i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2536 %! assert (cat (1, cast (1i, t1), cast ([2i; 3], t2)), cast ([1i; 2i; 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2537 %! assert (cat (1, cast ([1i; 2], t1), cast (3i, t2)), cast ([1i; 2; 3i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2538 %! assert (cat (1, cast ([1i; 2], t1), cast ([3i; 4], t2)), cast ([1i; 2; 3i; 4], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2539 %! assert (cat (2, cast (1i, t1), cast (2i, t2)), cast ([1i, 2i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2540 %! assert (cat (2, cast (1i, t1), cast ([2i, 3], t2)), cast ([1i, 2i, 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2541 %! assert (cat (2, cast ([1i, 2], t1), cast (3i, t2)), cast ([1i, 2, 3i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2542 %! assert (cat (2, cast ([1i, 2], t1), cast ([3i, 4], t2)), cast ([1i, 2, 3i, 4], tr));
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2543 %!
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2544 %! assert ([cast(1i, t1); cast(2i, t2)], cast ([1i; 2i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2545 %! assert ([cast(1i, t1); cast([2i; 3], t2)], cast ([1i; 2i; 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2546 %! assert ([cast([1i; 2], t1); cast(3i, t2)], cast ([1i; 2; 3i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2547 %! assert ([cast([1i; 2], t1); cast([3i; 4], t2)], cast ([1i; 2; 3i; 4], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2548 %! assert ([cast(1i, t1), cast(2i, t2)], cast ([1i, 2i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2549 %! assert ([cast(1i, t1), cast([2i, 3], t2)], cast ([1i, 2i, 3], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2550 %! assert ([cast([1i, 2], t1), cast(3i, t2)], cast ([1i, 2, 3i], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2551 %! assert ([cast([1i, 2], t1), cast([3i, 4], t2)], cast ([1i, 2, 3i, 4], tr));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2552 %! endif
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2553 %! ret = true;
14085 4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2554 %!endfunction
4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2555
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2556 %!assert (__testcat ("double", "double", "double"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2557 %!assert (__testcat ("single", "double", "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2558 %!assert (__testcat ("double", "single", "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2559 %!assert (__testcat ("single", "single", "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2560
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2561 %!assert (__testcat ("double", "int8", "int8", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2562 %!assert (__testcat ("int8", "double", "int8", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2563 %!assert (__testcat ("single", "int8", "int8", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2564 %!assert (__testcat ("int8", "single", "int8", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2565 %!assert (__testcat ("int8", "int8", "int8", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2566 %!assert (__testcat ("double", "int16", "int16", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2567 %!assert (__testcat ("int16", "double", "int16", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2568 %!assert (__testcat ("single", "int16", "int16", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2569 %!assert (__testcat ("int16", "single", "int16", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2570 %!assert (__testcat ("int16", "int16", "int16", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2571 %!assert (__testcat ("double", "int32", "int32", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2572 %!assert (__testcat ("int32", "double", "int32", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2573 %!assert (__testcat ("single", "int32", "int32", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2574 %!assert (__testcat ("int32", "single", "int32", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2575 %!assert (__testcat ("int32", "int32", "int32", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2576 %!assert (__testcat ("double", "int64", "int64", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2577 %!assert (__testcat ("int64", "double", "int64", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2578 %!assert (__testcat ("single", "int64", "int64", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2579 %!assert (__testcat ("int64", "single", "int64", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2580 %!assert (__testcat ("int64", "int64", "int64", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2581
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2582 %!assert (__testcat ("double", "uint8", "uint8", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2583 %!assert (__testcat ("uint8", "double", "uint8", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2584 %!assert (__testcat ("single", "uint8", "uint8", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2585 %!assert (__testcat ("uint8", "single", "uint8", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2586 %!assert (__testcat ("uint8", "uint8", "uint8", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2587 %!assert (__testcat ("double", "uint16", "uint16", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2588 %!assert (__testcat ("uint16", "double", "uint16", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2589 %!assert (__testcat ("single", "uint16", "uint16", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2590 %!assert (__testcat ("uint16", "single", "uint16", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2591 %!assert (__testcat ("uint16", "uint16", "uint16", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2592 %!assert (__testcat ("double", "uint32", "uint32", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2593 %!assert (__testcat ("uint32", "double", "uint32", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2594 %!assert (__testcat ("single", "uint32", "uint32", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2595 %!assert (__testcat ("uint32", "single", "uint32", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2596 %!assert (__testcat ("uint32", "uint32", "uint32", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2597 %!assert (__testcat ("double", "uint64", "uint64", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2598 %!assert (__testcat ("uint64", "double", "uint64", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2599 %!assert (__testcat ("single", "uint64", "uint64", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2600 %!assert (__testcat ("uint64", "single", "uint64", false))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2601 %!assert (__testcat ("uint64", "uint64", "uint64", false))
14085 4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2602
4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2603 %!assert (cat (3, [], [1,2;3,4]), [1,2;3,4])
4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2604 %!assert (cat (3, [1,2;3,4], []), [1,2;3,4])
4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2605 %!assert (cat (3, [], [1,2;3,4], []), [1,2;3,4])
4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2606 %!assert (cat (3, [], [], []), zeros (0, 0, 3))
4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2607
4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2608 %!assert (cat (3, [], [], 1, 2), cat (3, 1, 2))
4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2609 %!assert (cat (3, [], [], [1,2;3,4]), [1,2;3,4])
4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2610 %!assert (cat (4, [], [], [1,2;3,4]), [1,2;3,4])
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2611
18712 6113e0c6920b maint: Clean up extra spaces before/after parentheses. Rik <rik@octave.org> parents: 18710 diff changeset	2612 %!assert ([zeros(3,2,2); ones(1,2,2)], repmat ([0;0;0;1],[1,2,2]))
6113e0c6920b maint: Clean up extra spaces before/after parentheses. Rik <rik@octave.org> parents: 18710 diff changeset	2613 %!assert ([zeros(3,2,2); ones(1,2,2)], vertcat (zeros (3,2,2), ones (1,2,2)))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	2614
14085 4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2615 %!error <dimension mismatch> cat (3, cat (3, [], []), [1,2;3,4])
4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	2616 %!error <dimension mismatch> cat (3, zeros (0, 0, 2), [1,2;3,4])
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	2617 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	2618
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2619 static octave_value
6959 47f4f4e88166 [project @ 2007-10-04 20:43:32 by jwe] jwe parents: 6953 diff changeset	2620 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	2621 {
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2622 octave_value retval;
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2623
5148 9eab94f5fadf [project @ 2005-02-18 19:04:34 by jwe] jwe parents: 5061 diff changeset	2624 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	2625 {
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2626 Array<int> vec = args(1).int_vector_value ();
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2627
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2628 // 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	2629 // here and pass that to permute?
9eab94f5fadf [project @ 2005-02-18 19:04:34 by jwe] jwe parents: 5061 diff changeset	2630
20267 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20253 diff changeset	2631 int n = vec.numel ();
5148 9eab94f5fadf [project @ 2005-02-18 19:04:34 by jwe] jwe parents: 5061 diff changeset	2632
9eab94f5fadf [project @ 2005-02-18 19:04:34 by jwe] jwe parents: 5061 diff changeset	2633 for (int i = 0; i < n; i++)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2634 vec(i)--;
5148 9eab94f5fadf [project @ 2005-02-18 19:04:34 by jwe] jwe parents: 5061 diff changeset	2635
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2636 octave_value ret = args(0).permute (vec, inv);
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2637
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2638 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2639 retval = ret;
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2640 }
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2641 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2642 print_usage ();
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2643
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2644 return retval;
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2645 }
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2646
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2647 DEFUN (permute, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2648 "-- texinfo --\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	2649 @deftypefn {Built-in Function} {} permute (@var{A}, @var{perm})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	2650 Return the generalized transpose for an N-D array object @var{A}.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	2651 \n\
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2652 The permutation vector @var{perm} must contain the elements\n\
14861 f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory Rik <octave@nomad.inbox5.com> parents: 14853 diff changeset	2653 @code{1:ndims (A)} (in any order, but each element must appear only once).\n\
19107 ec1e295402fa doc: explain permute's PERM variable and give examples Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 19072 diff changeset	2654 \n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	2655 The @var{N}th dimension of @var{A} gets remapped to dimension\n\
19186 0f9c5a15c8fa doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 19152 diff changeset	2656 @code{@var{PERM}(@var{N})}. For example:\n\
19107 ec1e295402fa doc: explain permute's PERM variable and give examples Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 19072 diff changeset	2657 \n\
ec1e295402fa doc: explain permute's PERM variable and give examples Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 19072 diff changeset	2658 @example\n\
ec1e295402fa doc: explain permute's PERM variable and give examples Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 19072 diff changeset	2659 @group\n\
ec1e295402fa doc: explain permute's PERM variable and give examples Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 19072 diff changeset	2660 @var{x} = zeros ([2, 3, 5, 7]);\n\
ec1e295402fa doc: explain permute's PERM variable and give examples Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 19072 diff changeset	2661 size (@var{x})\n\
ec1e295402fa doc: explain permute's PERM variable and give examples Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 19072 diff changeset	2662 @result{} 2 3 5 7\n\
ec1e295402fa doc: explain permute's PERM variable and give examples Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 19072 diff changeset	2663 \n\
ec1e295402fa doc: explain permute's PERM variable and give examples Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 19072 diff changeset	2664 size (permute (@var{x}, [2, 1, 3, 4]))\n\
ec1e295402fa doc: explain permute's PERM variable and give examples Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 19072 diff changeset	2665 @result{} 3 2 5 7\n\
ec1e295402fa doc: explain permute's PERM variable and give examples Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 19072 diff changeset	2666 \n\
ec1e295402fa doc: explain permute's PERM variable and give examples Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 19072 diff changeset	2667 size (permute (@var{x}, [1, 3, 4, 2]))\n\
ec1e295402fa doc: explain permute's PERM variable and give examples Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 19072 diff changeset	2668 @result{} 2 5 7 3\n\
ec1e295402fa doc: explain permute's PERM variable and give examples Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 19072 diff changeset	2669 \n\
ec1e295402fa doc: explain permute's PERM variable and give examples Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 19072 diff changeset	2670 ## The identity permutation\n\
ec1e295402fa doc: explain permute's PERM variable and give examples Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 19072 diff changeset	2671 size (permute (@var{x}, [1, 2, 3, 4]))\n\
ec1e295402fa doc: explain permute's PERM variable and give examples Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 19072 diff changeset	2672 @result{} 2 3 5 7\n\
ec1e295402fa doc: explain permute's PERM variable and give examples Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 19072 diff changeset	2673 @end group\n\
ec1e295402fa doc: explain permute's PERM variable and give examples Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 19072 diff changeset	2674 @end example\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5607 diff changeset	2675 @seealso{ipermute}\n\
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5607 diff changeset	2676 @end deftypefn")
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2677 {
6959 47f4f4e88166 [project @ 2007-10-04 20:43:32 by jwe] jwe parents: 6953 diff changeset	2678 return do_permute (args, false);
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2679 }
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2680
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2681 DEFUN (ipermute, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2682 "-- texinfo --\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	2683 @deftypefn {Built-in Function} {} ipermute (@var{A}, @var{iperm})\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	2684 The inverse of the @code{permute} function.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	2685 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	2686 The expression\n\
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2687 \n\
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2688 @example\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	2689 ipermute (permute (A, perm), perm)\n\
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2690 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	2691 \n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	2692 @noindent\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	2693 returns the original array @var{A}.\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5607 diff changeset	2694 @seealso{permute}\n\
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5607 diff changeset	2695 @end deftypefn")
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2696 {
6959 47f4f4e88166 [project @ 2007-10-04 20:43:32 by jwe] jwe parents: 6953 diff changeset	2697 return do_permute (args, true);
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2698 }
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4569 diff changeset	2699
3195 7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	2700 DEFUN (length, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2701 "-- texinfo --\n\
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2702 @deftypefn {Built-in Function} {} length (@var{a})\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	2703 Return the length of the object @var{a}.\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	2704 \n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	2705 The length is 0 for empty objects, 1 for scalars, and the number of elements\n\
20433 fc23fbe05f3a doc: Clarify behavior of length() function (bug #45611). Rik <rik@octave.org> parents: 20218 diff changeset	2706 for vectors. For matrix or N-dimensional objects, the length is the number\n\
fc23fbe05f3a doc: Clarify behavior of length() function (bug #45611). Rik <rik@octave.org> parents: 20218 diff changeset	2707 of elements along the largest dimension\n\
fc23fbe05f3a doc: Clarify behavior of length() function (bug #45611). Rik <rik@octave.org> parents: 20218 diff changeset	2708 (equivalent to @w{@code{max (size (@var{a}))}}).\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	2709 @seealso{numel, size}\n\
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2710 @end deftypefn")
3195 7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	2711 {
7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	2712 octave_value retval;
7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	2713
7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	2714 if (args.length () == 1)
9706 71160b139b07 simplify length,ndims,size and size_equal Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	2715 retval = args(0).length ();
3195 7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	2716 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2717 print_usage ();
3195 7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	2718
7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	2719 return retval;
7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	2720 }
7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3186 diff changeset	2721
4554 78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2722 DEFUN (ndims, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2723 "-- texinfo --\n\
4554 78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2724 @deftypefn {Built-in Function} {} ndims (@var{a})\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	2725 Return the number of dimensions of @var{a}.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	2726 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	2727 For any array, the result will always be greater than or equal to 2.\n\
4554 78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2728 Trailing singleton dimensions are not counted.\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	2729 \n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	2730 @example\n\
10711 fbd7843974fa Periodic grammar check of documentation files to ensure common format. Rik <octave@nomad.inbox5.com> parents: 10707 diff changeset	2731 @group\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2732 ndims (ones (4, 1, 2, 1))\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2733 @result{} 3\n\
10711 fbd7843974fa Periodic grammar check of documentation files to ensure common format. Rik <octave@nomad.inbox5.com> parents: 10707 diff changeset	2734 @end group\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	2735 @end example\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	2736 @seealso{size}\n\
4554 78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2737 @end deftypefn")
78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2738 {
78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2739 octave_value retval;
78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2740
78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2741 if (args.length () == 1)
9706 71160b139b07 simplify length,ndims,size and size_equal Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	2742 retval = args(0).ndims ();
4554 78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2743 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2744 print_usage ();
4554 78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2745
78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2746 return retval;
78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2747 }
78e34346f6fd [project @ 2003-10-27 22:01:49 by jwe] jwe parents: 4545 diff changeset	2748
4559 802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2749 DEFUN (numel, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2750 "-- texinfo --\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	2751 @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	2752 @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	2753 Return the number of elements in the object @var{a}.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	2754 \n\
9705 5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2755 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	2756 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	2757 \n\
9705 5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2758 @example\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2759 @var{a}(@var{idx1}, @var{idx2}, @dots{})\n\
9705 5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2760 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	2761 \n\
13929 9cae456085c2 Grammarcheck of documentation before 3.6.0 release. Rik <octave@nomad.inbox5.com> parents: 13915 diff changeset	2762 Note that the indices do not have to be numerical. For example,\n\
12924 67a5acac8e1b Clarify what indices can be for numel Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12681 diff changeset	2763 \n\
67a5acac8e1b Clarify what indices can be for numel Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12681 diff changeset	2764 @example\n\
13929 9cae456085c2 Grammarcheck of documentation before 3.6.0 release. Rik <octave@nomad.inbox5.com> parents: 13915 diff changeset	2765 @group\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2766 @var{a} = 1;\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2767 @var{b} = ones (2, 3);\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2768 numel (@var{a}, @var{b})\n\
13929 9cae456085c2 Grammarcheck of documentation before 3.6.0 release. Rik <octave@nomad.inbox5.com> parents: 13915 diff changeset	2769 @end group\n\
12924 67a5acac8e1b Clarify what indices can be for numel Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12681 diff changeset	2770 @end example\n\
67a5acac8e1b Clarify what indices can be for numel Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12681 diff changeset	2771 \n\
13929 9cae456085c2 Grammarcheck of documentation before 3.6.0 release. Rik <octave@nomad.inbox5.com> parents: 13915 diff changeset	2772 @noindent\n\
12924 67a5acac8e1b Clarify what indices can be for numel Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12681 diff changeset	2773 will return 6, as this is the number of ways to index with @var{b}.\n\
67a5acac8e1b Clarify what indices can be for numel Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12681 diff changeset	2774 \n\
9705 5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2775 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	2776 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	2777 @seealso{size}\n\
4559 802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2778 @end deftypefn")
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2779 {
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2780 octave_value retval;
9329 67fc970dad7d improve indexed assignment using indexed numel Jaroslav Hajek <highegg@gmail.com> parents: 9319 diff changeset	2781 octave_idx_type nargin = args.length ();
67fc970dad7d improve indexed assignment using indexed numel Jaroslav Hajek <highegg@gmail.com> parents: 9319 diff changeset	2782
9705 5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2783 if (nargin == 1)
5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2784 retval = args(0).numel ();
5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2785 else if (nargin > 1)
4559 802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2786 {
9705 5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2787 // 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	2788 // an overloaded call, not to builtin!
5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9689 diff changeset	2789 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	2790 }
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2791 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2792 print_usage ();
4559 802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2793
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2794 return retval;
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2795 }
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	2796
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	2797 DEFUN (size, args, nargout,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2798 "-- texinfo --\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	2799 @deftypefn {Built-in Function} {} size (@var{a})\n\
a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	2800 @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	2801 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	2802 \n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2803 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	2804 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	2805 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	2806 etc. For example:\n\
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2807 \n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2808 @example\n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2809 @group\n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2810 size ([1, 2; 3, 4; 5, 6])\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2811 @result{} [ 3, 2 ]\n\
1031 59f5eb2d5eb3 [project @ 1995-01-15 21:11:11 by jwe] jwe parents: 1009 diff changeset	2812 \n\
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2813 [nr, nc] = size ([1, 2; 3, 4; 5, 6])\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2814 @result{} nr = 3\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2815 @result{} nc = 2\n\
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2816 @end group\n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2817 @end example\n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2818 \n\
4741 e44d0ac643a5 [project @ 2004-02-05 21:57:50 by jwe] jwe parents: 4739 diff changeset	2819 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	2820 corresponding dimension. For example,\n\
1031 59f5eb2d5eb3 [project @ 1995-01-15 21:11:11 by jwe] jwe parents: 1009 diff changeset	2821 \n\
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2822 @example\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	2823 @group\n\
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2824 size ([1, 2; 3, 4; 5, 6], 2)\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2825 @result{} 2\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	2826 @end group\n\
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2827 @end example\n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2828 \n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2829 @noindent\n\
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2830 returns the number of columns in the given matrix.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	2831 @seealso{numel, ndims, length, rows, columns}\n\
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	2832 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2833 {
2086 bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe] jwe parents: 1996 diff changeset	2834 octave_value_list retval;
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2835
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2836 int nargin = args.length ();
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2837
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4512 diff changeset	2838 if (nargin == 1)
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2839 {
9706 71160b139b07 simplify length,ndims,size and size_equal Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	2840 const dim_vector dimensions = args(0).dims ();
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4512 diff changeset	2841
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4512 diff changeset	2842 if (nargout > 1)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2843 {
9706 71160b139b07 simplify length,ndims,size and size_equal Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	2844 const dim_vector rdims = dimensions.redim (nargout);
71160b139b07 simplify length,ndims,size and size_equal Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	2845 retval.resize (nargout);
71160b139b07 simplify length,ndims,size and size_equal Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	2846 for (int i = 0; i < nargout; i++)
71160b139b07 simplify length,ndims,size and size_equal Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	2847 retval(i) = rdims(i);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2848 }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4512 diff changeset	2849 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2850 {
9706 71160b139b07 simplify length,ndims,size and size_equal Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	2851 int ndims = dimensions.length ();
71160b139b07 simplify length,ndims,size and size_equal Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	2852
71160b139b07 simplify length,ndims,size and size_equal Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	2853 NoAlias<Matrix> m (1, ndims);
71160b139b07 simplify length,ndims,size and size_equal Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	2854
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2855 for (int i = 0; i < ndims; i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2856 m(i) = dimensions(i);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2857
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2858 retval(0) = m;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2859 }
1031 59f5eb2d5eb3 [project @ 1995-01-15 21:11:11 by jwe] jwe parents: 1009 diff changeset	2860 }
59f5eb2d5eb3 [project @ 1995-01-15 21:11:11 by jwe] jwe parents: 1009 diff changeset	2861 else if (nargin == 2 && nargout < 2)
59f5eb2d5eb3 [project @ 1995-01-15 21:11:11 by jwe] jwe parents: 1009 diff changeset	2862 {
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5164 diff changeset	2863 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	2864
59f5eb2d5eb3 [project @ 1995-01-15 21:11:11 by jwe] jwe parents: 1009 diff changeset	2865 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	2866 error ("size: DIM must be a scalar");
712 36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	2867 else
10315 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 const dim_vector dv = args(0).dims ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2870
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2871 if (nd > 0)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2872 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2873 if (nd <= dv.length ())
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2874 retval(0) = dv(nd-1);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	2875 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2876 retval(0) = 1;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2877 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2878 else
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	2879 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	2880 }
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2881 }
712 36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	2882 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2883 print_usage ();
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2884
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2885 return retval;
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2886 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2887
6156 a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2888 DEFUN (size_equal, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2889 "-- texinfo --\n\
6561 dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2890 @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	2891 Return true if the dimensions of all arguments agree.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	2892 \n\
6156 a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2893 Trailing singleton dimensions are ignored.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	2894 When called with a single or no argument @code{size_equal} returns true.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	2895 @seealso{size, numel, ndims}\n\
6156 a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2896 @end deftypefn")
a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2897 {
a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2898 octave_value retval;
a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2899
6561 dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2900 int nargin = args.length ();
dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2901
10002 e93c9bfff8b8 allow size_equal with 0 arguments Jaroslav Hajek <highegg@gmail.com> parents: 9866 diff changeset	2902 retval = true;
e93c9bfff8b8 allow size_equal with 0 arguments Jaroslav Hajek <highegg@gmail.com> parents: 9866 diff changeset	2903
8947 1e4b3149365a allow size_equal called with 1 arg Jaroslav Hajek <highegg@gmail.com> parents: 8934 diff changeset	2904 if (nargin >= 1)
6156 a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2905 {
a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2906 dim_vector a_dims = args(0).dims ();
6561 dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2907
dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2908 for (int i = 1; i < nargin; ++i)
dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2909 {
dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2910 dim_vector b_dims = args(i).dims ();
dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2911
dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2912 if (a_dims != b_dims)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2913 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2914 retval = false;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2915 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	2916 }
6561 dc83c15d7149 [project @ 2007-04-23 16:58:17 by jwe] jwe parents: 6556 diff changeset	2917 }
6156 a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2918 }
a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2919
a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2920 return retval;
a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2921 }
a46f14cdbecd [project @ 2006-11-13 19:20:23 by jwe] jwe parents: 6133 diff changeset	2922
5602 dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2923 DEFUN (nnz, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2924 "-- texinfo --\n\
18848 53af80da6781 doc: Update documentation of sparse functions including seealso links. Rik <rik@octave.org> parents: 18823 diff changeset	2925 @deftypefn {Built-in Function} {@var{n} =} nnz (@var{a})\n\
18851 9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 18850 diff changeset	2926 Return the number of nonzero elements in @var{a}.\n\
18848 53af80da6781 doc: Update documentation of sparse functions including seealso links. Rik <rik@octave.org> parents: 18823 diff changeset	2927 @seealso{nzmax, nonzeros, find}\n\
5602 dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2928 @end deftypefn")
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2929 {
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2930 octave_value retval;
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2931
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2932 if (args.length () == 1)
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2933 retval = args(0).nnz ();
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2934 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2935 print_usage ();
5602 dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2936
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2937 return retval;
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2938 }
dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5533 diff changeset	2939
5604 2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2940 DEFUN (nzmax, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2941 "-- texinfo --\n\
18848 53af80da6781 doc: Update documentation of sparse functions including seealso links. Rik <rik@octave.org> parents: 18823 diff changeset	2942 @deftypefn {Built-in Function} {@var{n} =} nzmax (@var{SM})\n\
5604 2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2943 Return the amount of storage allocated to the sparse matrix @var{SM}.\n\
18848 53af80da6781 doc: Update documentation of sparse functions including seealso links. Rik <rik@octave.org> parents: 18823 diff changeset	2944 \n\
7001 8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe] jwe parents: 6999 diff changeset	2945 Note that Octave tends to crop unused memory at the first opportunity\n\
18848 53af80da6781 doc: Update documentation of sparse functions including seealso links. Rik <rik@octave.org> parents: 18823 diff changeset	2946 for sparse objects. Thus, in general the value of @code{nzmax} will be the\n\
20218 4e7f12a763cd doc: Remove typo of same word twice in a row. Rik <rik@octave.org> parents: 20207 diff changeset	2947 same as @code{nnz} except for some cases of user-created sparse objects.\n\
15034 1116864ee270 doc: Fix for bad cross-referencing due to use of aliases in Texinfo. Rik <rik@octave.org> parents: 15031 diff changeset	2948 @seealso{nnz, spalloc, sparse}\n\
5604 2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2949 @end deftypefn")
2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2950 {
2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2951 octave_value retval;
2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2952
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	2953 if (args.length () == 1)
5604 2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2954 retval = args(0).nzmax ();
2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2955 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2956 print_usage ();
5604 2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2957
2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2958 return retval;
2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2959 }
2857357f9d3c [project @ 2006-01-31 18:22:59 by jwe] jwe parents: 5602 diff changeset	2960
5677 a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2961 DEFUN (rows, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2962 "-- texinfo --\n\
5677 a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2963 @deftypefn {Built-in Function} {} rows (@var{a})\n\
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2964 Return the number of rows of @var{a}.\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	2965 @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	2966 @end deftypefn")
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2967 {
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2968 octave_value retval;
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2969
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2970 if (args.length () == 1)
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2971 retval = args(0).rows ();
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2972 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2973 print_usage ();
5677 a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2974
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2975 return retval;
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2976 }
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2977
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2978 DEFUN (columns, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2979 "-- texinfo --\n\
5677 a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2980 @deftypefn {Built-in Function} {} columns (@var{a})\n\
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2981 Return the number of columns of @var{a}.\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	2982 @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	2983 @end deftypefn")
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2984 {
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2985 octave_value retval;
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2986
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2987 if (args.length () == 1)
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2988 retval = args(0).columns ();
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2989 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	2990 print_usage ();
5677 a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2991
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2992 return retval;
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2993 }
a8f6903535c9 [project @ 2006-03-16 05:54:20 by jwe] jwe parents: 5642 diff changeset	2994
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	2995 DEFUN (sum, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	2996 "-- texinfo --\n\
9163 9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	2997 @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	2998 @deftypefnx {Built-in Function} {} sum (@var{x}, @var{dim})\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	2999 @deftypefnx {Built-in Function} {} sum (@dots{}, \"native\")\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	3000 @deftypefnx {Built-in Function} {} sum (@dots{}, \"double\")\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	3001 @deftypefnx {Built-in Function} {} sum (@dots{}, \"extra\")\n\
18760 5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18759 diff changeset	3002 Sum of elements along dimension @var{dim}.\n\
5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18759 diff changeset	3003 \n\
5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18759 diff changeset	3004 If @var{dim} is omitted, it defaults to the first non-singleton dimension.\n\
5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18759 diff changeset	3005 \n\
18851 9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 18850 diff changeset	3006 The optional @qcode{\"type\"} input determines the class of the variable\n\
9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 18850 diff changeset	3007 used for calculations. If the argument @qcode{\"native\"} is given, then\n\
9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 18850 diff changeset	3008 the operation is performed in the same type as the original argument, rather\n\
9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 18850 diff changeset	3009 than the default double type.\n\
18760 5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18759 diff changeset	3010 \n\
5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18759 diff changeset	3011 For example:\n\
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	3012 \n\
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	3013 @example\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	3014 @group\n\
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	3015 sum ([true, true])\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	3016 @result{} 2\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	3017 sum ([true, true], \"native\")\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	3018 @result{} true\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	3019 @end group\n\
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	3020 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	3021 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	3022 On the contrary, if @qcode{\"double\"} is given, the sum is performed in\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	3023 double precision even for single precision inputs.\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	3024 \n\
18851 9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 18850 diff changeset	3025 For double precision inputs, the @qcode{\"extra\"} option will use a more\n\
9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 18850 diff changeset	3026 accurate algorithm than straightforward summation. For single precision\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	3027 inputs, @qcode{\"extra\"} is the same as @qcode{\"double\"}. Otherwise,\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	3028 @qcode{\"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	3029 @seealso{cumsum, sumsq, prod}\n\
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	3030 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3031 {
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3032 octave_value retval;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3033
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3034 int nargin = args.length ();
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3035
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3036 bool isnative = false;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3037 bool isdouble = false;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3038 bool isextra = false;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3039
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3040 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	3041 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3042 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	3043
19777 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	3044 if (str == "native")
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	3045 isnative = true;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	3046 else if (str == "double")
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	3047 isdouble = true;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	3048 else if (str == "extra")
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	3049 isextra = true;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	3050 else
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	3051 error ("sum: unrecognized type argument '%s'", str.c_str ());
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19773 diff changeset	3052 nargin --;
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3053 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3054
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3055 if (error_state)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3056 return retval;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3057
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3058 if (nargin == 1 \|\| nargin == 2)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3059 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3060 octave_value arg = args(0);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3061
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3062 int dim = -1;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3063 if (nargin == 2)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3064 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3065 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	3066 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	3067 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	3068 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3069
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3070 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3071 {
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3072 switch (arg.builtin_type ())
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3073 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3074 case btyp_double:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3075 if (arg.is_sparse_type ())
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3076 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3077 if (isextra)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3078 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	3079 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	3080 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3081 else if (isextra)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3082 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	3083 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3084 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	3085 break;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3086 case btyp_complex:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3087 if (arg.is_sparse_type ())
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3088 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3089 if (isextra)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3090 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	3091 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	3092 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3093 else if (isextra)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3094 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	3095 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3096 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	3097 break;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3098 case btyp_float:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3099 if (isdouble \|\| isextra)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3100 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	3101 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3102 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	3103 break;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3104 case btyp_float_complex:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3105 if (isdouble \|\| isextra)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3106 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	3107 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3108 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	3109 break;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3110
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3111 #define MAKE_INT_BRANCH(X) \
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3112 case btyp_ ## X: \
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3113 if (isnative) \
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3114 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	3115 else \
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3116 retval = arg.X ## _array_value ().dsum (dim); \
18760 5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18759 diff changeset	3117 break;
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3118 MAKE_INT_BRANCH (int8);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3119 MAKE_INT_BRANCH (int16);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3120 MAKE_INT_BRANCH (int32);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3121 MAKE_INT_BRANCH (int64);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3122 MAKE_INT_BRANCH (uint8);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3123 MAKE_INT_BRANCH (uint16);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3124 MAKE_INT_BRANCH (uint32);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3125 MAKE_INT_BRANCH (uint64);
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3126 #undef MAKE_INT_BRANCH
19631 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19630 diff changeset	3127
18759 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 18713 diff changeset	3128 // GAGME: Accursed Matlab compatibility...
15621 e9d842dcfc91 data.cc (Fsum): allow string arguments for Matlab compatibility Jordi Gutiérrez Hermoso <jordigh@octave.org>* parents: 15509 diff changeset	3129 case btyp_char:
e9d842dcfc91 data.cc (Fsum): allow string arguments for Matlab compatibility Jordi Gutiérrez Hermoso <jordigh@octave.org>* parents: 15509 diff changeset	3130 if (isextra)
e9d842dcfc91 data.cc (Fsum): allow string arguments for Matlab compatibility Jordi Gutiérrez Hermoso <jordigh@octave.org>* parents: 15509 diff changeset	3131 retval = arg.array_value (true).xsum (dim);
e9d842dcfc91 data.cc (Fsum): allow string arguments for Matlab compatibility Jordi Gutiérrez Hermoso <jordigh@octave.org>* parents: 15509 diff changeset	3132 else
e9d842dcfc91 data.cc (Fsum): allow string arguments for Matlab compatibility Jordi Gutiérrez Hermoso <jordigh@octave.org>* parents: 15509 diff changeset	3133 retval = arg.array_value (true).sum (dim);
e9d842dcfc91 data.cc (Fsum): allow string arguments for Matlab compatibility Jordi Gutiérrez Hermoso <jordigh@octave.org>* parents: 15509 diff changeset	3134 break;
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3135 case btyp_bool:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3136 if (arg.is_sparse_type ())
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3137 {
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3138 if (isnative)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3139 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	3140 else
10983 4b51c0a20a98 optimize sum of sparse logical matrices Jaroslav Hajek <highegg@gmail.com> parents: 10880 diff changeset	3141 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	3142 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3143 else if (isnative)
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3144 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	3145 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3146 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	3147 break;
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3148
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3149 default:
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3150 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	3151 }
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3152 }
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3153 }
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3154 else
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3155 print_usage ();
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3156
192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9706 diff changeset	3157 return retval;
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3158 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3159
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	3160 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3161 %!assert (sum ([1, 2, 3]), 6)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3162 %!assert (sum ([-1; -2; -3]), -6)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3163 %!assert (sum ([i, 2+i, -3+2i, 4]), 3+4i)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3164 %!assert (sum ([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i]), [2+2i, 4+4i, 6+6i])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3165
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3166 %!assert (sum (single ([1, 2, 3])), single (6))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3167 %!assert (sum (single ([-1; -2; -3])), single (-6))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3168 %!assert (sum (single ([i, 2+i, -3+2i, 4])), single (3+4i))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3169 %!assert (sum (single ([1, 2, 3; i, 2i, 3i; 1+i, 2+2i, 3+3i])), single ([2+2i, 4+4i, 6+6i]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3170
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3171 %!assert (sum ([1, 2; 3, 4], 1), [4, 6])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3172 %!assert (sum ([1, 2; 3, 4], 2), [3; 7])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3173 %!assert (sum (zeros (1, 0)), 0)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3174 %!assert (sum (zeros (1, 0), 1), zeros (1, 0))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3175 %!assert (sum (zeros (1, 0), 2), 0)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3176 %!assert (sum (zeros (0, 1)), 0)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3177 %!assert (sum (zeros (0, 1), 1), 0)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3178 %!assert (sum (zeros (0, 1), 2), zeros (0, 1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3179 %!assert (sum (zeros (2, 0)), zeros (1, 0))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3180 %!assert (sum (zeros (2, 0), 1), zeros (1, 0))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3181 %!assert (sum (zeros (2, 0), 2), [0; 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3182 %!assert (sum (zeros (0, 2)), [0, 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3183 %!assert (sum (zeros (0, 2), 1), [0, 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3184 %!assert (sum (zeros (0, 2), 2), zeros (0, 1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3185 %!assert (sum (zeros (2, 2, 0, 3)), zeros (1, 2, 0, 3))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3186 %!assert (sum (zeros (2, 2, 0, 3), 2), zeros (2, 1, 0, 3))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3187 %!assert (sum (zeros (2, 2, 0, 3), 3), zeros (2, 2, 1, 3))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3188 %!assert (sum (zeros (2, 2, 0, 3), 4), zeros (2, 2, 0))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3189 %!assert (sum (zeros (2, 2, 0, 3), 7), zeros (2, 2, 0, 3))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3190
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3191 %!assert (sum (single ([1, 2; 3, 4]), 1), single ([4, 6]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3192 %!assert (sum (single ([1, 2; 3, 4]), 2), single ([3; 7]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3193 %!assert (sum (zeros (1, 0, "single")), single (0))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3194 %!assert (sum (zeros (1, 0, "single"), 1), zeros (1, 0, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3195 %!assert (sum (zeros (1, 0, "single"), 2), single (0))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3196 %!assert (sum (zeros (0, 1, "single")), single (0))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3197 %!assert (sum (zeros (0, 1, "single"), 1), single (0))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3198 %!assert (sum (zeros (0, 1, "single"), 2), zeros (0, 1, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3199 %!assert (sum (zeros (2, 0, "single")), zeros (1, 0, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3200 %!assert (sum (zeros (2, 0, "single"), 1), zeros (1, 0, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3201 %!assert (sum (zeros (2, 0, "single"), 2), single ([0; 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3202 %!assert (sum (zeros (0, 2, "single")), single ([0, 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3203 %!assert (sum (zeros (0, 2, "single"), 1), single ([0, 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3204 %!assert (sum (zeros (0, 2, "single"), 2), zeros (0, 1, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3205 %!assert (sum (zeros (2, 2, 0, 3, "single")), zeros (1, 2, 0, 3, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3206 %!assert (sum (zeros (2, 2, 0, 3, "single"), 2), zeros (2, 1, 0, 3, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3207 %!assert (sum (zeros (2, 2, 0, 3, "single"), 3), zeros (2, 2, 1, 3, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3208 %!assert (sum (zeros (2, 2, 0, 3, "single"), 4), zeros (2, 2, 0, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3209 %!assert (sum (zeros (2, 2, 0, 3, "single"), 7), zeros (2, 2, 0, 3, "single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3210
18760 5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18759 diff changeset	3211 ## Test "native"
5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18759 diff changeset	3212 %!assert (sum ([true,true]), 2)
5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18759 diff changeset	3213 %!assert (sum ([true,true], "native"), true)
5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18759 diff changeset	3214 %!assert (sum (int8 ([127,10,-20])), 117)
5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18759 diff changeset	3215 %!assert (sum (int8 ([127,10,-20]), "native"), int8 (107))
5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18759 diff changeset	3216
15623 d928ad126b66 maint: add a new test for Fsum corresponding to cset e9d842dcfc91 Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 15621 diff changeset	3217 ;-)
d928ad126b66 maint: add a new test for Fsum corresponding to cset e9d842dcfc91 Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 15621 diff changeset	3218 %!assert (sum ("Octave") + "8", sumsq (primes (17)))
d928ad126b66 maint: add a new test for Fsum corresponding to cset e9d842dcfc91 Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 15621 diff changeset	3219
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3220 %!error sum ()
18760 5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18759 diff changeset	3221 %!error sum (1,2,3)
5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18759 diff changeset	3222 %!error <unrecognized type argument 'foobar'> sum (1, "foobar")
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	3223 */
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7103 diff changeset	3224
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	3225 DEFUN (sumsq, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3226 "-- texinfo --\n\
9163 9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	3227 @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	3228 @deftypefnx {Built-in Function} {} sumsq (@var{x}, @var{dim})\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	3229 Sum of squares of elements along dimension @var{dim}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	3230 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	3231 If @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	3232 \n\
4689ee5e88ec [project @ 2004-11-03 21:23:42 by jwe] jwe parents: 5058 diff changeset	3233 This function is conceptually equivalent to computing\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	3234 \n\
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	3235 @example\n\
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	3236 sum (x .* conj (x), dim)\n\
4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	3237 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	3238 \n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	3239 @noindent\n\
9163 9cb0c21e97f7 Update section 17.4 (Sums and Products) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9155 diff changeset	3240 but it uses less memory and avoids calling @code{conj} if @var{x} is real.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	3241 @seealso{sum, prod}\n\
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	3242 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3243 {
3723 4c3774db5b3c [project @ 2000-10-12 05:10:08 by jwe] jwe parents: 3665 diff changeset	3244 DATA_REDUCTION (sumsq);
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3245 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	3246
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	3247 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3248 %!assert (sumsq ([1, 2, 3]), 14)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3249 %!assert (sumsq ([-1; -2; 4i]), 21)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3250 %!assert (sumsq ([1, 2, 3; 2, 3, 4; 4i, 6i, 2]), [21, 49, 29])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3251
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3252 %!assert (sumsq (single ([1, 2, 3])), single (14))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3253 %!assert (sumsq (single ([-1; -2; 4i])), single (21))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3254 %!assert (sumsq (single ([1, 2, 3; 2, 3, 4; 4i, 6i, 2])), single ([21, 49, 29]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3255
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3256 %!assert (sumsq ([1, 2; 3, 4], 1), [10, 20])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3257 %!assert (sumsq ([1, 2; 3, 4], 2), [5; 25])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3258
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3259 %!assert (sumsq (single ([1, 2; 3, 4]), 1), single ([10, 20]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3260 %!assert (sumsq (single ([1, 2; 3, 4]), 2), single ([5; 25]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3261
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3262 %!error sumsq ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3263 */
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	3264
6688 b26a8e0e42cd [project @ 2007-06-04 06:25:21 by jwe] jwe parents: 6671 diff changeset	3265 DEFUN (islogical, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3266 "-- texinfo --\n\
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	3267 @deftypefn {Built-in Function} {} islogical (@var{x})\n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	3268 @deftypefnx {Built-in Function} {} isbool (@var{x})\n\
6688 b26a8e0e42cd [project @ 2007-06-04 06:25:21 by jwe] jwe parents: 6671 diff changeset	3269 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	3270 @seealso{isfloat, isinteger, ischar, isnumeric, isa}\n\
3439 3234a698073a [project @ 2000-01-14 09:51:14 by jwe] jwe parents: 3428 diff changeset	3271 @end deftypefn")
3209 fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	3272 {
fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	3273 octave_value retval;
fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	3274
fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	3275 if (args.length () == 1)
3258 4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	3276 retval = args(0).is_bool_type ();
3209 fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	3277 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	3278 print_usage ();
3209 fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	3279
fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	3280 return retval;
fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	3281 }
fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	3282
6688 b26a8e0e42cd [project @ 2007-06-04 06:25:21 by jwe] jwe parents: 6671 diff changeset	3283 DEFALIAS (isbool, islogical);
3209 fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe] jwe parents: 3206 diff changeset	3284
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	3285 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3286 %!assert (islogical (true), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3287 %!assert (islogical (false), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3288 %!assert (islogical ([true, false]), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3289 %!assert (islogical (1), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3290 %!assert (islogical (1i), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3291 %!assert (islogical ([1,1]), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3292 %!assert (islogical (single (1)), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3293 %!assert (islogical (single (1i)), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3294 %!assert (islogical (single ([1,1])), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3295 %!assert (islogical (sparse ([true, false])), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3296 %!assert (islogical (sparse ([1, 0])), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3297 */
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	3298
6223 a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	3299 DEFUN (isinteger, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3300 "-- texinfo --\n\
6230 06bee64edc08 [project @ 2007-01-08 16:59:35 by jwe] jwe parents: 6223 diff changeset	3301 @deftypefn {Built-in Function} {} isinteger (@var{x})\n\
6223 a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	3302 Return true if @var{x} is an integer object (int8, uint8, int16, etc.).\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	3303 \n\
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	3304 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	3305 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	3306 @seealso{isfloat, ischar, islogical, isnumeric, isa}\n\
6223 a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	3307 @end deftypefn")
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	3308 {
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	3309 octave_value retval;
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	3310
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	3311 if (args.length () == 1)
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	3312 retval = args(0).is_integer_type ();
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	3313 else
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	3314 print_usage ();
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	3315
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	3316 return retval;
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	3317 }
a6cc01dd09f9 [project @ 2007-01-03 20:59:28 by jwe] jwe parents: 6197 diff changeset	3318
4028 ef75c970c8f5 [project @ 2002-08-09 07:19:02 by jwe] jwe parents: 4025 diff changeset	3319 DEFUN (iscomplex, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3320 "-- texinfo --\n\
4028 ef75c970c8f5 [project @ 2002-08-09 07:19:02 by jwe] jwe parents: 4025 diff changeset	3321 @deftypefn {Built-in Function} {} iscomplex (@var{x})\n\
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	3322 Return true if @var{x} is a complex-valued numeric object.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	3323 @seealso{isreal, isnumeric, islogical, ischar, isfloat, isa}\n\
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	3324 @end deftypefn")
3186 edaa9a2d3d9c [project @ 1998-10-02 19:12:19 by jwe] jwe parents: 3174 diff changeset	3325 {
edaa9a2d3d9c [project @ 1998-10-02 19:12:19 by jwe] jwe parents: 3174 diff changeset	3326 octave_value retval;
edaa9a2d3d9c [project @ 1998-10-02 19:12:19 by jwe] jwe parents: 3174 diff changeset	3327
edaa9a2d3d9c [project @ 1998-10-02 19:12:19 by jwe] jwe parents: 3174 diff changeset	3328 if (args.length () == 1)
3258 4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	3329 retval = args(0).is_complex_type ();
3186 edaa9a2d3d9c [project @ 1998-10-02 19:12:19 by jwe] jwe parents: 3174 diff changeset	3330 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	3331 print_usage ();
3186 edaa9a2d3d9c [project @ 1998-10-02 19:12:19 by jwe] jwe parents: 3174 diff changeset	3332
edaa9a2d3d9c [project @ 1998-10-02 19:12:19 by jwe] jwe parents: 3174 diff changeset	3333 return retval;
edaa9a2d3d9c [project @ 1998-10-02 19:12:19 by jwe] jwe parents: 3174 diff changeset	3334 }
edaa9a2d3d9c [project @ 1998-10-02 19:12:19 by jwe] jwe parents: 3174 diff changeset	3335
7576 7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	3336 DEFUN (isfloat, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3337 "-- texinfo --\n\
7576 7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	3338 @deftypefn {Built-in Function} {} isfloat (@var{x})\n\
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	3339 Return true if @var{x} is a floating-point numeric object.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	3340 \n\
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	3341 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	3342 @seealso{isinteger, ischar, islogical, isnumeric, isa}\n\
7576 7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	3343 @end deftypefn")
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	3344 {
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	3345 octave_value retval;
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	3346
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	3347 if (args.length () == 1)
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	3348 retval = args(0).is_float_type ();
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	3349 else
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	3350 print_usage ();
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	3351
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	3352 return retval;
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	3353 }
7ebdc99a0bab new isfloat function John W. Eaton <jwe@octave.org> parents: 7515 diff changeset	3354
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3355 // FIXME: perhaps this should be implemented with an
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3356 // octave_value member function?
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3357
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3358 DEFUN (complex, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3359 "-- texinfo --\n\
9309 fb8b8589dd46 Expand documentation for 'complex' function Rik <rdrider0-list@yahoo.com> parents: 9308 diff changeset	3360 @deftypefn {Built-in Function} {} complex (@var{x})\n\
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3361 @deftypefnx {Built-in Function} {} complex (@var{re}, @var{im})\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	3362 Return a complex value from real arguments.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	3363 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	3364 With 1 real argument @var{x}, return the complex result @code{@var{x} + 0i}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	3365 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	3366 With 2 real arguments, return the complex result @code{@var{re} + @var{im}}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	3367 @code{complex} can often be more convenient than expressions such as\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	3368 @code{a + i*b}.\n\
9309 fb8b8589dd46 Expand documentation for 'complex' function Rik <rdrider0-list@yahoo.com> parents: 9308 diff changeset	3369 For example:\n\
fb8b8589dd46 Expand documentation for 'complex' function Rik <rdrider0-list@yahoo.com> parents: 9308 diff changeset	3370 \n\
fb8b8589dd46 Expand documentation for 'complex' function Rik <rdrider0-list@yahoo.com> parents: 9308 diff changeset	3371 @example\n\
9758 09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format Rik <rdrider0-list@yahoo.com> parents: 9736 diff changeset	3372 @group\n\
9309 fb8b8589dd46 Expand documentation for 'complex' function Rik <rdrider0-list@yahoo.com> parents: 9308 diff changeset	3373 complex ([1, 2], [3, 4])\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	3374 @result{} [ 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	3375 @end group\n\
9309 fb8b8589dd46 Expand documentation for 'complex' function Rik <rdrider0-list@yahoo.com> parents: 9308 diff changeset	3376 @end example\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	3377 @seealso{real, imag, iscomplex, abs, arg}\n\
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3378 @end deftypefn")
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3379 {
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3380 octave_value retval;
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3381
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3382 int nargin = args.length ();
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3383
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3384 if (nargin == 1)
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3385 {
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3386 octave_value arg = args(0);
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3387
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3388 if (arg.is_complex_type ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3389 retval = arg;
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3390 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3391 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3392 if (arg.is_sparse_type ())
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 SparseComplexMatrix val = arg.sparse_complex_matrix_value ();
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 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3397 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	3398 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3399 else if (arg.is_single_type ())
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3400 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3401 if (arg.numel () == 1)
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 FloatComplex val = arg.float_complex_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3404
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3405 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3406 retval = octave_value (new octave_float_complex (val));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3407 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3408 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3409 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3410 FloatComplexNDArray val = arg.float_complex_array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3411
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3412 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3413 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	3414 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3415 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3416 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3417 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3418 if (arg.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3419 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3420 Complex val = arg.complex_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3421
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3422 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3423 retval = octave_value (new octave_complex (val));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3424 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3425 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3426 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3427 ComplexNDArray val = arg.complex_array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3428
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3429 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3430 retval = octave_value (new octave_complex_matrix (val));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3431 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3432 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3433
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3434 if (error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3435 error ("complex: invalid conversion");
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3436 }
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3437 }
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3438 else if (nargin == 2)
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3439 {
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3440 octave_value re = args(0);
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3441 octave_value im = args(1);
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3442
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	3443 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	3444 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3445 const SparseMatrix re_val = re.sparse_matrix_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3446 const SparseMatrix im_val = im.sparse_matrix_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3447
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3448 if (!error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3449 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3450 if (re.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3451 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3452 SparseComplexMatrix result;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3453 if (re_val.nnz () == 0)
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	3454 result = Complex (0, 1) * SparseComplexMatrix (im_val);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3455 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3456 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3457 octave_idx_type nr = im_val.rows ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3458 octave_idx_type nc = im_val.cols ();
18809 ac0c04e4d141 Fix segfault with sparse inputs to complex() (bug #42290). Rik <rik@octave.org> parents: 17915 diff changeset	3459 result = SparseComplexMatrix (nr, nc, re_val(0));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3460
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3461 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	3462 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3463 octave_idx_type off = j * nr;
14861 f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory Rik <octave@nomad.inbox5.com> parents: 14853 diff changeset	3464 for (octave_idx_type i = im_val.cidx (j);
f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory Rik <octave@nomad.inbox5.com> parents: 14853 diff changeset	3465 i < im_val.cidx (j + 1); i++)
18809 ac0c04e4d141 Fix segfault with sparse inputs to complex() (bug #42290). Rik <rik@octave.org> parents: 17915 diff changeset	3466 result.data (im_val.ridx (i) + off) +=
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3467 Complex (0, im_val.data (i));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3468 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3469 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3470 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	3471 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3472 else if (im.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3473 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3474 SparseComplexMatrix result;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3475 if (im_val.nnz () == 0)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3476 result = SparseComplexMatrix (re_val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3477 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3478 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3479 octave_idx_type nr = re_val.rows ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3480 octave_idx_type nc = re_val.cols ();
18809 ac0c04e4d141 Fix segfault with sparse inputs to complex() (bug #42290). Rik <rik@octave.org> parents: 17915 diff changeset	3481 result = SparseComplexMatrix (nr, nc,
ac0c04e4d141 Fix segfault with sparse inputs to complex() (bug #42290). Rik <rik@octave.org> parents: 17915 diff changeset	3482 Complex (0, im_val(0)));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3483
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3484 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	3485 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3486 octave_idx_type off = j * nr;
14861 f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory Rik <octave@nomad.inbox5.com> parents: 14853 diff changeset	3487 for (octave_idx_type i = re_val.cidx (j);
f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory Rik <octave@nomad.inbox5.com> parents: 14853 diff changeset	3488 i < re_val.cidx (j + 1); i++)
18809 ac0c04e4d141 Fix segfault with sparse inputs to complex() (bug #42290). Rik <rik@octave.org> parents: 17915 diff changeset	3489 result.data (re_val.ridx (i) + off) +=
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3490 re_val.data (i);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3491 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3492 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3493 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	3494 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3495 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3496 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3497 if (re_val.dims () == im_val.dims ())
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3498 {
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3499 SparseComplexMatrix result;
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3500 result = SparseComplexMatrix (re_val)
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3501 + Complex (0, 1) * SparseComplexMatrix (im_val);
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3502 retval = octave_value (
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3503 new octave_sparse_complex_matrix (result));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3504 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3505 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3506 error ("complex: dimension mismatch");
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3507 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3508 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3509 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	3510 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	3511 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3512 if (re.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3513 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3514 float re_val = re.float_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3515
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3516 if (im.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3517 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3518 float im_val = im.double_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3519
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3520 if (! error_state)
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3521 retval = octave_value (
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3522 new octave_float_complex (FloatComplex (re_val,
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3523 im_val)));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3524 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3525 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3526 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3527 const FloatNDArray im_val = im.float_array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3528
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3529 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3530 {
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3531 FloatComplexNDArray result (im_val.dims (),
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3532 FloatComplex ());
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3533
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3534 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	3535 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	3536
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3537 retval = octave_value (
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3538 new octave_float_complex_matrix (result));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3539 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3540 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3541 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3542 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3543 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3544 const FloatNDArray re_val = re.float_array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3545
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3546 if (im.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3547 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3548 float im_val = im.float_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3549
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3550 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3551 {
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3552 FloatComplexNDArray result (re_val.dims (),
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3553 FloatComplex ());
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3554
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3555 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	3556 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	3557
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3558 retval = octave_value (
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3559 new octave_float_complex_matrix (result));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3560 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3561 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3562 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3563 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3564 const FloatNDArray im_val = im.float_array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3565
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3566 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3567 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3568 if (re_val.dims () == im_val.dims ())
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3569 {
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3570 FloatComplexNDArray result (re_val.dims (),
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3571 FloatComplex ());
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3572
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3573 for (octave_idx_type i = 0; i < re_val.numel (); i++)
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3574 result.xelem (i) = FloatComplex (re_val(i),
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3575 im_val(i));
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3576
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3577 retval = octave_value (
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3578 new octave_float_complex_matrix (result));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3579 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3580 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3581 error ("complex: dimension mismatch");
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3582 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3583 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3584 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3585 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	3586 else if (re.numel () == 1)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3587 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3588 double re_val = re.double_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3589
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3590 if (im.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3591 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3592 double im_val = im.double_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3593
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3594 if (! error_state)
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3595 retval = octave_value (new octave_complex (Complex (re_val,
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3596 im_val)));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3597 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3598 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3599 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3600 const NDArray im_val = im.array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3601
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3602 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3603 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3604 ComplexNDArray result (im_val.dims (), Complex ());
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3605
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3606 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	3607 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	3608
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3609 retval = octave_value (new octave_complex_matrix (result));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3610 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3611 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3612 }
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3613 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3614 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3615 const NDArray re_val = re.array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3616
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3617 if (im.numel () == 1)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3618 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3619 double im_val = im.double_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3620
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3621 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3622 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3623 ComplexNDArray result (re_val.dims (), Complex ());
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3624
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3625 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	3626 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	3627
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3628 retval = octave_value (new octave_complex_matrix (result));
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3629 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3630 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3631 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3632 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3633 const NDArray im_val = im.array_value ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3634
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3635 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3636 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3637 if (re_val.dims () == im_val.dims ())
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3638 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3639 ComplexNDArray result (re_val.dims (), Complex ());
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3640
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3641 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	3642 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	3643
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3644 retval = octave_value (
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3645 new octave_complex_matrix (result));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3646 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3647 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3648 error ("complex: dimension mismatch");
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3649 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3650 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3651 }
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3652
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3653 if (error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	3654 error ("complex: invalid conversion");
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3655 }
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3656 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	3657 print_usage ();
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3658
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3659 return retval;
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3660 }
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5333 diff changeset	3661
3258 4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	3662 DEFUN (isreal, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3663 "-- texinfo --\n\
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	3664 @deftypefn {Built-in Function} {} isreal (@var{x})\n\
10291 fc879f361bda make isreal matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10290 diff changeset	3665 Return true if @var{x} is a non-complex matrix or scalar.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	3666 \n\
10711 fbd7843974fa Periodic grammar check of documentation files to ensure common format. Rik <octave@nomad.inbox5.com> parents: 10707 diff changeset	3667 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	3668 matrices.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	3669 @seealso{iscomplex, isnumeric, isa}\n\
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	3670 @end deftypefn")
3258 4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	3671 {
4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	3672 octave_value retval;
4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	3673
4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	3674 if (args.length () == 1)
4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	3675 retval = args(0).is_real_type ();
4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	3676 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	3677 print_usage ();
3258 4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	3678
4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	3679 return retval;
4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	3680 }
4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	3681
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3682 DEFUN (isempty, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3683 "-- texinfo --\n\
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	3684 @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	3685 Return true if @var{a} is an empty matrix (any one of its dimensions is\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	3686 zero).\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	3687 @seealso{isnull, isa}\n\
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3369 diff changeset	3688 @end deftypefn")
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3689 {
4233 ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe] jwe parents: 4176 diff changeset	3690 octave_value retval = false;
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3691
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3692 if (args.length () == 1)
4559 802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4556 diff changeset	3693 retval = args(0).is_empty ();
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3694 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	3695 print_usage ();
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3696
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3697 return retval;
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3698 }
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3699
16779 8fce0ed4894a Specialize is_empty and numel methods for sparse matrices (debian bug #706376) David Bateman <dbateman@free.fr> parents: 16077 diff changeset	3700 /*
8fce0ed4894a Specialize is_empty and numel methods for sparse matrices (debian bug #706376) David Bateman <dbateman@free.fr> parents: 16077 diff changeset	3701 %% Debian bug #706376
8fce0ed4894a Specialize is_empty and numel methods for sparse matrices (debian bug #706376) David Bateman <dbateman@free.fr> parents: 16077 diff changeset	3702 %!assert (isempty (speye(2^16)), false)
8fce0ed4894a Specialize is_empty and numel methods for sparse matrices (debian bug #706376) David Bateman <dbateman@free.fr> parents: 16077 diff changeset	3703 */
8fce0ed4894a Specialize is_empty and numel methods for sparse matrices (debian bug #706376) David Bateman <dbateman@free.fr> parents: 16077 diff changeset	3704
3206 d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	3705 DEFUN (isnumeric, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3706 "-- texinfo --\n\
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	3707 @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	3708 Return true if @var{x} is a numeric object, i.e., an integer, real, or\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	3709 complex array.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	3710 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	3711 Logical and character arrays are not considered to be numeric.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	3712 @seealso{isinteger, isfloat, isreal, iscomplex, islogical, ischar, iscell, isstruct, isa}\n\
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3418 diff changeset	3713 @end deftypefn")
3206 d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	3714 {
d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	3715 octave_value retval;
d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	3716
d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	3717 if (args.length () == 1)
3258 4964d5391acc [project @ 1999-07-21 21:51:33 by jwe] jwe parents: 3238 diff changeset	3718 retval = args(0).is_numeric_type ();
3206 d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	3719 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	3720 print_usage ();
3206 d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	3721
d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	3722 return retval;
d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	3723 }
d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe] jwe parents: 3204 diff changeset	3724
11435 20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	3725 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3726 %!assert (isnumeric (1), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3727 %!assert (isnumeric (1i), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3728 %!assert (isnumeric ([1,1]), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3729 %!assert (isnumeric (single (1)), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3730 %!assert (isnumeric (single (1i)), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3731 %!assert (isnumeric (single ([1,1])), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3732 %!assert (isnumeric (int8 (1)), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3733 %!assert (isnumeric (uint8 ([1,1])), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3734 %!assert (isnumeric ("Hello World"), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3735 %!assert (isnumeric (true), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3736 %!assert (isnumeric (false), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3737 %!assert (isnumeric ([true, false]), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3738 %!assert (isnumeric (sparse ([true, false])), false)
11435 20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	3739 */
20f53b3a558f Add tests for sparse forms of logical matrices to islogical, isnumeric. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	3740
18852 bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3741 DEFUN (isscalar, args, ,
19895 19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19829 diff changeset	3742 "-- texinfo --\n\
18852 bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3743 @deftypefn {Built-in Function} {} isscalar (@var{x})\n\
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3744 Return true if @var{x} is a scalar.\n\
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3745 @seealso{isvector, ismatrix}\n\
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3746 @end deftypefn")
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3747 {
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3748 octave_value retval;
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3749
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3750 if (args.length () == 1)
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3751 retval = args(0).numel () == 1;
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3752 else
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3753 print_usage ();
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3754
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3755 return retval;
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3756 }
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3757
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3758 /*
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3759 %!assert (isscalar (1))
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3760 %!assert (isscalar ([1, 2]), false)
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3761 %!assert (isscalar ([]), false)
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3762 %!assert (isscalar ([1, 2; 3, 4]), false)
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3763
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3764 %!assert (isscalar ("t"))
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3765 %!assert (isscalar ("test"), false)
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3766 %!assert (isscalar (["test"; "ing"]), false)
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3767
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3768 %!test
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3769 %! s.a = 1;
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3770 %! assert (isscalar (s));
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3771
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3772 %% Test input validation
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3773 %!error isscalar ()
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3774 %!error isscalar (1, 2)
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3775 */
bc52657a7d29 Convert isscalar from an m-file to a built-in function (bug #42422). Jason Alan Palmer <jalanpalmer@gmail.com> parents: 18851 diff changeset	3776
18853 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3777 DEFUN (isvector, args, ,
19895 19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19829 diff changeset	3778 "-- texinfo --\n\
18853 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3779 @deftypefn {Function File} {} isvector (@var{x})\n\
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3780 Return true if @var{x} is a vector.\n\
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3781 \n\
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3782 A vector is a 2-D array where one of the dimensions is equal to 1. As a\n\
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3783 consequence a 1x1 array, or scalar, is also a vector.\n\
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3784 @seealso{isscalar, ismatrix, size, rows, columns, length}\n\
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3785 @end deftypefn")
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3786 {
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3787 octave_value retval;
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3788
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3789 if (args.length () == 1)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3790 {
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3791 dim_vector sz = args(0).dims ();
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3792 retval = sz.length () == 2 && (sz(0) == 1 \|\| sz(1) == 1);
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3793 }
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3794 else
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3795 print_usage ();
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3796
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3797 return retval;
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3798 }
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3799
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3800 /*
19734 00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3801 %!assert (isvector (1), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3802 %!assert (isvector ([1; 2; 3]), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3803 %!assert (isvector ([1, 2, 3]), true)
18853 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3804 %!assert (isvector ([]), false)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3805 %!assert (isvector ([1, 2; 3, 4]), false)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3806
19734 00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3807 %!assert (isvector ("t"), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3808 %!assert (isvector ("test"), true)
18853 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3809 %!assert (isvector (["test"; "ing"]), false)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3810
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3811 %!test
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3812 %! s.a = 1;
19734 00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3813 %! assert (isvector (s), true);
18853 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3814
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3815 %% Test input validation
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3816 %!error isvector ()
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3817 %!error isvector ([1, 2], 2)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3818 */
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3819
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3820 DEFUN (isrow, args, ,
19895 19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19829 diff changeset	3821 "-- texinfo --\n\
18853 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3822 @deftypefn {Function File} {} isrow (@var{x})\n\
19829 ca7599ae464d doc: Grammarcheck documentation ahead of 4.0 release. Rik <rik@octave.org> parents: 19783 diff changeset	3823 Return true if @var{x} is a row vector 1xN with non-negative N.\n\
18853 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3824 @seealso{iscolumn, isscalar, isvector, ismatrix}\n\
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3825 @end deftypefn")
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3826 {
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3827 octave_value retval;
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3828
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3829 if (args.length () == 1)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3830 {
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3831 dim_vector sz = args(0).dims ();
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3832 retval = sz.length () == 2 && sz(0) == 1;
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3833 }
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3834 else
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3835 print_usage ();
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3836
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3837 return retval;
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3838 }
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3839
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3840 /*
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3841 %!assert (isrow ([1, 2, 3]))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3842 %!assert (isrow ([1; 2; 3]), false)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3843 %!assert (isrow (1))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3844 %!assert (isrow ([]), false)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3845 %!assert (isrow ([1, 2; 3, 4]), false)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3846
19734 00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3847 %!assert (isrow (ones (1, 0)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3848 %!assert (isrow (ones (1, 1)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3849 %!assert (isrow (ones (1, 2)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3850 %!assert (isrow (ones (1, 1, 1)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3851 %!assert (isrow (ones (1, 1, 1, 1)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3852
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3853 %!assert (isrow (ones (0, 0)), false)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3854 %!assert (isrow (ones (1, 1, 0)), false)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3855
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3856
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3857 %!assert (isrow ("t"), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3858 %!assert (isrow ("test"), true)
18853 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3859 %!assert (isrow (["test"; "ing"]), false)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3860
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3861 %!test
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3862 %! s.a = 1;
19734 00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3863 %! assert (isrow (s), true);
18853 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3864
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3865 %% Test input validation
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3866 %!error isrow ()
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3867 %!error isrow ([1, 2], 2)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3868 */
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3869
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3870 DEFUN (iscolumn, args, ,
19895 19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19829 diff changeset	3871 "-- texinfo --\n\
18853 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3872 @deftypefn {Function File} {} iscolumn (@var{x})\n\
19829 ca7599ae464d doc: Grammarcheck documentation ahead of 4.0 release. Rik <rik@octave.org> parents: 19783 diff changeset	3873 Return true if @var{x} is a column vector Nx1 with non-negative N.\n\
18853 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3874 @seealso{isrow, isscalar, isvector, ismatrix}\n\
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3875 @end deftypefn")
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3876 {
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3877 octave_value retval;
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3878
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3879 if (args.length () == 1)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3880 {
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3881 dim_vector sz = args(0).dims ();
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3882 retval = sz.length () == 2 && sz(1) == 1;
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3883 }
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3884 else
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3885 print_usage ();
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3886
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3887 return retval;
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3888 }
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3889
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3890 /*
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3891 %!assert (iscolumn ([1, 2, 3]), false)
19734 00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3892 %!assert (iscolumn ([1; 2; 3]), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3893 %!assert (iscolumn (1), true)
18853 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3894 %!assert (iscolumn ([]), false)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3895 %!assert (iscolumn ([1, 2; 3, 4]), false)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3896
19734 00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3897 %!assert (iscolumn ("t"), true)
18853 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3898 %!assert (iscolumn ("test"), false)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3899 %!assert (iscolumn (["test"; "ing"]), false)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3900
19734 00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3901 %!assert (iscolumn (ones (0, 1)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3902 %!assert (iscolumn (ones (1, 1)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3903 %!assert (iscolumn (ones (2, 1)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3904 %!assert (iscolumn (ones (1, 1, 1)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3905 %!assert (iscolumn (ones (1, 1, 1, 1)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3906
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3907 %!assert (iscolumn (ones (0, 0)), false)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3908 %!assert (iscolumn (ones (0, 1, 0)), false)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3909
18853 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3910 %!test
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3911 %! s.a = 1;
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3912 %! assert (iscolumn (s));
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3913
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3914 %% Test input validation
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3915 %!error iscolumn ()
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3916 %!error iscolumn ([1, 2], 2)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3917 */
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3918
4028 ef75c970c8f5 [project @ 2002-08-09 07:19:02 by jwe] jwe parents: 4025 diff changeset	3919 DEFUN (ismatrix, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	3920 "-- texinfo --\n\
4028 ef75c970c8f5 [project @ 2002-08-09 07:19:02 by jwe] jwe parents: 4025 diff changeset	3921 @deftypefn {Built-in Function} {} ismatrix (@var{a})\n\
19829 ca7599ae464d doc: Grammarcheck documentation ahead of 4.0 release. Rik <rik@octave.org> parents: 19783 diff changeset	3922 Return true if @var{a} is a 2-D array.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	3923 @seealso{isscalar, isvector, iscell, isstruct, issparse, isa}\n\
3333 15cddaacbc2d [project @ 1999-11-03 19:53:59 by jwe] jwe parents: 3322 diff changeset	3924 @end deftypefn")
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3925 {
4233 ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe] jwe parents: 4176 diff changeset	3926 octave_value retval = false;
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3927
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3928 if (args.length () == 1)
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3929 {
19734 00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3930 dim_vector sz = args(0).dims ();
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3931 retval = (sz.length () == 2) && (sz(0) >= 0) && (sz(1) >= 0);
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3932 }
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3933 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	3934 print_usage ();
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3935
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3936 return retval;
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3937 }
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3195 diff changeset	3938
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3939 /*
19734 00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3940 %!assert (ismatrix ([]), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3941 %!assert (ismatrix (1), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3942 %!assert (ismatrix ([1, 2, 3]), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3943 %!assert (ismatrix ([1, 2; 3, 4]), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3944
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3945 %!assert (ismatrix (zeros (0)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3946 %!assert (ismatrix (zeros (0, 0)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3947 %!assert (ismatrix (zeros (0, 0, 0)), false)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3948 %!assert (ismatrix (zeros (3, 2, 4)), false)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3949
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3950 %!assert (ismatrix (single ([])), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3951 %!assert (ismatrix (single (1)), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3952 %!assert (ismatrix (single ([1, 2, 3])), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3953 %!assert (ismatrix (single ([1, 2; 3, 4])), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3954
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3955 %!assert (ismatrix ("t"), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3956 %!assert (ismatrix ("test"), true)
00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3957 %!assert (ismatrix (["test"; "ing"]), true)
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3958
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3959 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3960 %! s.a = 1;
19734 00e31f316a3a Fix Matlab incompatibility of "ismatrix" (bug #42422). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19731 diff changeset	3961 %! assert (ismatrix (s), true);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3962
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3963 %!error ismatrix ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3964 %!error ismatrix ([1, 2; 3, 4], 2)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	3965 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	3966
18853 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3967 DEFUN (issquare, args, ,
19895 19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19829 diff changeset	3968 "-- texinfo --\n\
18853 4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3969 @deftypefn {Function File} {} issquare (@var{x})\n\
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3970 Return true if @var{x} is a square matrix.\n\
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3971 @seealso{isscalar, isvector, ismatrix, size}\n\
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3972 @end deftypefn")
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3973 {
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3974 octave_value retval;
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3975
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3976 if (args.length () == 1)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3977 {
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3978 dim_vector sz = args(0).dims ();
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3979 retval = sz.length () == 2 && sz(0) == sz(1);
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3980 }
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3981 else
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3982 print_usage ();
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3983
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3984 return retval;
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3985 }
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3986
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3987 /*
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3988 %!assert (issquare ([]))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3989 %!assert (issquare (1))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3990 %!assert (! issquare ([1, 2]))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3991 %!assert (issquare ([1, 2; 3, 4]))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3992 %!assert (! issquare ([1, 2; 3, 4; 5, 6]))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3993 %!assert (! issquare (ones (3,3,3)))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3994 %!assert (issquare ("t"))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3995 %!assert (! issquare ("test"))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3996 %!assert (issquare (["test"; "ing"; "1"; "2"]))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3997 %!test
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3998 %! s.a = 1;
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	3999 %! assert (issquare (s));
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	4000 %!assert (issquare ({1, 2; 3, 4}))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	4001 %!assert (sparse (([1, 2; 3, 4])))
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	4002
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	4003 %% Test input validation
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	4004 %!error issquare ()
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	4005 %!error issquare ([1, 2; 3, 4], 2)
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	4006 */
4f0e4f20a33f Promote isvector, isrow, iscolumn, issquare to C++ versions (bug #42454). Rik <rik@octave.org> parents: 18852 diff changeset	4007
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	4008 static octave_value
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4009 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	4010 {
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	4011 octave_value retval;
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4012
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4013 int nargin = args.length ();
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4014
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4015 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	4016
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4017 dim_vector dims (1, 1);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4018
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4019 if (nargin > 0 && args(nargin-1).is_string ())
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4020 {
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4021 std::string nm = args(nargin-1).string_value ();
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4022 nargin--;
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4023
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4024 dt = oct_data_conv::string_to_data_type (nm);
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4025
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4026 if (error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4027 return retval;
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4028 }
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4029
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4030 switch (nargin)
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4031 {
712 36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	4032 case 0:
36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	4033 break;
777 a2f9d3fd720c [project @ 1994-10-07 14:01:53 by jwe] jwe parents: 767 diff changeset	4034
610 14b2a186a5c0 [project @ 1994-08-14 00:55:49 by jwe] jwe parents: 597 diff changeset	4035 case 1:
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4036 get_dimensions (args(0), fcn, dims);
610 14b2a186a5c0 [project @ 1994-08-14 00:55:49 by jwe] jwe parents: 597 diff changeset	4037 break;
777 a2f9d3fd720c [project @ 1994-10-07 14:01:53 by jwe] jwe parents: 767 diff changeset	4038
4563 742993a501b9 [project @ 2003-10-29 06:25:12 by jwe] jwe parents: 4559 diff changeset	4039 default:
742993a501b9 [project @ 2003-10-29 06:25:12 by jwe] jwe parents: 4559 diff changeset	4040 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4041 dims.resize (nargin);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4042
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4043 for (int i = 0; i < nargin; i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4044 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4045 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	4046
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4047 if (error_state)
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 error ("%s: expecting scalar integer arguments", fcn);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4050 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4051 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4052 }
4563 742993a501b9 [project @ 2003-10-29 06:25:12 by jwe] jwe parents: 4559 diff changeset	4053 }
742993a501b9 [project @ 2003-10-29 06:25:12 by jwe] jwe parents: 4559 diff changeset	4054 break;
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4055 }
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4056
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4057 if (! error_state)
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4058 {
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4059 dims.chop_trailing_singletons ();
4565 1db951a4fcd5 [project @ 2003-10-29 13:49:30 by jwe] jwe parents: 4563 diff changeset	4060
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4061 check_dimensions (dims, fcn);
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	4062
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	4063 // FIXME: perhaps this should be made extensible by
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4064 // 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	4065 // the new value.
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4066
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4067 // Note that automatic narrowing will handle conversion from
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4068 // NDArray to scalar.
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	4069
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4479 diff changeset	4070 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4071 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4072 switch (dt)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4073 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4074 case oct_data_conv::dt_int8:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4075 retval = int8NDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4076 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4077
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4078 case oct_data_conv::dt_uint8:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4079 retval = uint8NDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4080 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4081
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4082 case oct_data_conv::dt_int16:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4083 retval = int16NDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4084 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4085
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4086 case oct_data_conv::dt_uint16:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4087 retval = uint16NDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4088 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4089
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4090 case oct_data_conv::dt_int32:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4091 retval = int32NDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4092 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4093
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4094 case oct_data_conv::dt_uint32:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4095 retval = uint32NDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4096 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4097
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4098 case oct_data_conv::dt_int64:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4099 retval = int64NDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4100 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4101
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4102 case oct_data_conv::dt_uint64:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4103 retval = uint64NDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4104 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4105
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4106 case oct_data_conv::dt_single:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4107 retval = FloatNDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4108 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4109
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4110 case oct_data_conv::dt_double:
8972 5fa53d1b6247 more indexing optimizations Jaroslav Hajek <highegg@gmail.com> parents: 8947 diff changeset	4111 {
20253 b2100e1659ac maint: Use cuddled parentheses when indexing dimension_vectors. Rik <rik@octave.org> parents: 20218 diff changeset	4112 if (val == 1 && dims.length () == 2 && dims(0) == 1)
b2100e1659ac maint: Use cuddled parentheses when indexing dimension_vectors. Rik <rik@octave.org> parents: 20218 diff changeset	4113 retval = Range (1.0, 0.0, dims(1)); // packed form
8972 5fa53d1b6247 more indexing optimizations Jaroslav Hajek <highegg@gmail.com> parents: 8947 diff changeset	4114 else
5fa53d1b6247 more indexing optimizations Jaroslav Hajek <highegg@gmail.com> parents: 8947 diff changeset	4115 retval = NDArray (dims, val);
5fa53d1b6247 more indexing optimizations Jaroslav Hajek <highegg@gmail.com> parents: 8947 diff changeset	4116 }
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4117 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4118
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4119 case oct_data_conv::dt_logical:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4120 retval = boolNDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4121 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4122
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4123 default:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4124 error ("%s: invalid class name", fcn);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4125 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4126 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4127 }
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4128 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4129
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4130 return retval;
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4131 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4132
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4133 static octave_value
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4134 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	4135 const char *fcn)
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4136 {
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4137 octave_value retval;
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4138
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4139 int nargin = args.length ();
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4140
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4141 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	4142
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4143 dim_vector dims (1, 1);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4144
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4145 if (nargin > 0 && args(nargin-1).is_string ())
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4146 {
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4147 std::string nm = args(nargin-1).string_value ();
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4148 nargin--;
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4149
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4150 dt = oct_data_conv::string_to_data_type (nm);
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4151
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4152 if (error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4153 return retval;
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4154 }
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4155
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4156 switch (nargin)
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4157 {
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4158 case 0:
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4159 break;
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4160
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4161 case 1:
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4162 get_dimensions (args(0), fcn, dims);
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4163 break;
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4164
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4165 default:
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4166 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4167 dims.resize (nargin);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4168
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4169 for (int i = 0; i < nargin; i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4170 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4171 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	4172
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4173 if (error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4174 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4175 error ("%s: expecting scalar integer arguments", fcn);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4176 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4177 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4178 }
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4179 }
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4180 break;
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4181 }
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4182
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4183 if (! error_state)
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4184 {
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4185 dims.chop_trailing_singletons ();
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4186
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4187 check_dimensions (dims, fcn);
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4188
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4189 // Note that automatic narrowing will handle conversion from
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4190 // NDArray to scalar.
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4191
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4192 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4193 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4194 switch (dt)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4195 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4196 case oct_data_conv::dt_single:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4197 retval = FloatNDArray (dims, fval);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4198 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4199
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4200 case oct_data_conv::dt_double:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4201 retval = NDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4202 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4203
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4204 default:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4205 error ("%s: invalid class name", fcn);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4206 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4207 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4208 }
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4209 }
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4210
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4211 return retval;
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4212 }
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4213
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4214 static octave_value
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4215 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	4216 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4217 octave_value retval;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4218
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4219 int nargin = args.length ();
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4220
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4221 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	4222
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4223 dim_vector dims (1, 1);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4224
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4225 if (nargin > 0 && args(nargin-1).is_string ())
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4226 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4227 std::string nm = args(nargin-1).string_value ();
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4228 nargin--;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4229
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4230 dt = oct_data_conv::string_to_data_type (nm);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4231
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4232 if (error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4233 return retval;
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4234 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4235
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4236 switch (nargin)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4237 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4238 case 0:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4239 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4240
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4241 case 1:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4242 get_dimensions (args(0), fcn, dims);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4243 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4244
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4245 default:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4246 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4247 dims.resize (nargin);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4248
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4249 for (int i = 0; i < nargin; i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4250 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4251 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	4252
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4253 if (error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4254 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4255 error ("%s: expecting scalar integer arguments", fcn);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4256 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4257 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4258 }
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4259 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4260 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4261 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4262
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4263 if (! error_state)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4264 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4265 dims.chop_trailing_singletons ();
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4266
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4267 check_dimensions (dims, fcn);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4268
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4269 // Note that automatic narrowing will handle conversion from
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4270 // NDArray to scalar.
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4271
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4272 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4273 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4274 switch (dt)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4275 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4276 case oct_data_conv::dt_single:
19773 3fa35defe495 Adjust spacing of static_cast<> calls to follow Octave coding conventions. Rik <rik@octave.org> parents: 19772 diff changeset	4277 retval = FloatNDArray (dims, static_cast<float> (val));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4278 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4279
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4280 case oct_data_conv::dt_double:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4281 retval = NDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4282 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4283
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4284 default:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4285 error ("%s: invalid class name", fcn);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4286 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4287 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4288 }
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4289 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4290
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4291 return retval;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4292 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4293
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4294 static octave_value
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4295 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	4296 const char *fcn)
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4297 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4298 octave_value retval;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4299
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4300 int nargin = args.length ();
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4301
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4302 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	4303
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4304 dim_vector dims (1, 1);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4305
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4306 if (nargin > 0 && args(nargin-1).is_string ())
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4307 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4308 std::string nm = args(nargin-1).string_value ();
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4309 nargin--;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4310
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4311 dt = oct_data_conv::string_to_data_type (nm);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4312
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4313 if (error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4314 return retval;
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4315 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4316
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4317 switch (nargin)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4318 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4319 case 0:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4320 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4321
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4322 case 1:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4323 get_dimensions (args(0), fcn, dims);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4324 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4325
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4326 default:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4327 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4328 dims.resize (nargin);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4329
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4330 for (int i = 0; i < nargin; i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4331 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4332 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	4333
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4334 if (error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4335 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4336 error ("%s: expecting scalar integer arguments", fcn);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4337 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4338 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4339 }
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4340 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4341 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4342 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4343
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4344 if (! error_state)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4345 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4346 dims.chop_trailing_singletons ();
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4347
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4348 check_dimensions (dims, fcn);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4349
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4350 // Note that automatic narrowing will handle conversion from
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4351 // NDArray to scalar.
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4352
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4353 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4354 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4355 switch (dt)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4356 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4357 case oct_data_conv::dt_single:
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	4358 retval = FloatComplexNDArray (dims,
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	4359 static_cast<FloatComplex> (val));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4360 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4361
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4362 case oct_data_conv::dt_double:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4363 retval = ComplexNDArray (dims, val);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4364 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4365
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4366 default:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4367 error ("%s: invalid class name", fcn);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4368 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4369 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4370 }
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4371 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4372
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4373 return retval;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4374 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4375
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4376 static octave_value
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4377 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	4378 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4379 octave_value retval;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4380
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4381 int nargin = args.length ();
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4382
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4383 dim_vector dims (1, 1);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4384
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4385 switch (nargin)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4386 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4387 case 0:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4388 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4389
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4390 case 1:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4391 get_dimensions (args(0), fcn, dims);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4392 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4393
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4394 default:
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4395 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4396 dims.resize (nargin);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4397
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4398 for (int i = 0; i < nargin; i++)
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 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	4401
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4402 if (error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4403 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4404 error ("%s: expecting scalar integer arguments", fcn);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4405 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4406 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4407 }
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4408 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4409 break;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4410 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4411
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4412 if (! error_state)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4413 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4414 dims.chop_trailing_singletons ();
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4415
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4416 check_dimensions (dims, fcn);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4417
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4418 // Note that automatic narrowing will handle conversion from
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4419 // NDArray to scalar.
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4420
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4421 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4422 retval = boolNDArray (dims, val);
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4423 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4424
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4425 return retval;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4426 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4427
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	4428 DEFUN (ones, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	4429 "-- texinfo --\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	4430 @deftypefn {Built-in Function} {} ones (@var{n})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	4431 @deftypefnx {Built-in Function} {} ones (@var{m}, @var{n})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	4432 @deftypefnx {Built-in Function} {} ones (@var{m}, @var{n}, @var{k}, @dots{})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	4433 @deftypefnx {Built-in Function} {} ones ([@var{m} @var{n} @dots{}])\n\
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	4434 @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	4435 Return a matrix or N-dimensional array whose elements are all 1.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4436 \n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	4437 If invoked with a single scalar integer argument @var{n}, return a square\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4438 @nospell{NxN} matrix.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4439 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4440 If invoked with two or more scalar integer arguments, or a vector of integer\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4441 values, return an array with the given dimensions.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4442 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4443 To create a constant matrix whose values are all the same use an expression\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4444 such as\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4445 \n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4446 @example\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	4447 val_matrix = val * ones (m, n)\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4448 @end example\n\
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4449 \n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	4450 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	4451 and defaults to double. For example:\n\
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4452 \n\
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4453 @example\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	4454 val = ones (m,n, \"uint8\")\n\
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4455 @end example\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	4456 @seealso{zeros}\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4457 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4458 {
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4459 return fill_matrix (args, 1, "ones");
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4460 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4461
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4462 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4463 %!assert (ones (3), [1, 1, 1; 1, 1, 1; 1, 1, 1])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4464 %!assert (ones (2, 3), [1, 1, 1; 1, 1, 1])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4465 %!assert (ones (3, 2), [1, 1; 1, 1; 1, 1])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4466 %!assert (size (ones (3, 4, 5)), [3, 4, 5])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4467
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4468 %!assert (ones (3, "single"), single ([1, 1, 1; 1, 1, 1; 1, 1, 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4469 %!assert (ones (2, 3, "single"), single ([1, 1, 1; 1, 1, 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4470 %!assert (ones (3, 2, "single"), single ([1, 1; 1, 1; 1, 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4471 %!assert (size (ones (3, 4, 5, "single")), [3, 4, 5])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4472
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4473 %!assert (ones (3, "int8"), int8 ([1, 1, 1; 1, 1, 1; 1, 1, 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4474 %!assert (ones (2, 3, "int8"), int8 ([1, 1, 1; 1, 1, 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4475 %!assert (ones (3, 2, "int8"), int8 ([1, 1; 1, 1; 1, 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4476 %!assert (size (ones (3, 4, 5, "int8")), [3, 4, 5])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4477 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4478
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	4479 DEFUN (zeros, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	4480 "-- texinfo --\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	4481 @deftypefn {Built-in Function} {} zeros (@var{n})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	4482 @deftypefnx {Built-in Function} {} zeros (@var{m}, @var{n})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	4483 @deftypefnx {Built-in Function} {} zeros (@var{m}, @var{n}, @var{k}, @dots{})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	4484 @deftypefnx {Built-in Function} {} zeros ([@var{m} @var{n} @dots{}])\n\
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	4485 @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	4486 Return a matrix or N-dimensional array whose elements are all 0.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4487 \n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	4488 If invoked with a single scalar integer argument, return a square\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4489 @nospell{NxN} matrix.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4490 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4491 If invoked with two or more scalar integer arguments, or a vector of integer\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4492 values, return an array with the given dimensions.\n\
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4493 \n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	4494 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	4495 and defaults to double. For example:\n\
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4496 \n\
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4497 @example\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	4498 val = zeros (m,n, \"uint8\")\n\
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	4499 @end example\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	4500 @seealso{ones}\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	4501 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4502 {
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4503 return fill_matrix (args, 0, "zeros");
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4504 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4505
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4506 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4507 %!assert (zeros (3), [0, 0, 0; 0, 0, 0; 0, 0, 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4508 %!assert (zeros (2, 3), [0, 0, 0; 0, 0, 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4509 %!assert (zeros (3, 2), [0, 0; 0, 0; 0, 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4510 %!assert (size (zeros (3, 4, 5)), [3, 4, 5])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4511
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4512 %!assert (zeros (3, "single"), single ([0, 0, 0; 0, 0, 0; 0, 0, 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4513 %!assert (zeros (2, 3, "single"), single ([0, 0, 0; 0, 0, 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4514 %!assert (zeros (3, 2, "single"), single ([0, 0; 0, 0; 0, 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4515 %!assert (size (zeros (3, 4, 5, "single")), [3, 4, 5])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4516
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4517 %!assert (zeros (3, "int8"), int8 ([0, 0, 0; 0, 0, 0; 0, 0, 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4518 %!assert (zeros (2, 3, "int8"), int8 ([0, 0, 0; 0, 0, 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4519 %!assert (zeros (3, 2, "int8"), int8 ([0, 0; 0, 0; 0, 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4520 %!assert (size (zeros (3, 4, 5, "int8")), [3, 4, 5])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4521 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4522
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4523 DEFUN (Inf, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	4524 "-- texinfo --\n\
14171 2ced2f59f523 doc: miscellaneous documentation improvements Rik <octave@nomad.inbox5.com> parents: 14169 diff changeset	4525 @c List other form of function in documentation index\n\
2ced2f59f523 doc: miscellaneous documentation improvements Rik <octave@nomad.inbox5.com> parents: 14169 diff changeset	4526 @findex inf\n\
2ced2f59f523 doc: miscellaneous documentation improvements Rik <octave@nomad.inbox5.com> parents: 14169 diff changeset	4527 \n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4528 @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	4529 @deftypefnx {Built-in Function} {} Inf (@var{n})\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4530 @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	4531 @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	4532 @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	4533 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	4534 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	4535 \n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4536 Infinity is produced when results are too large to be represented using the\n\
20218 4e7f12a763cd doc: Remove typo of same word twice in a row. Rik <rik@octave.org> parents: 20207 diff changeset	4537 IEEE floating point format for numbers. Two common examples which produce\n\
4e7f12a763cd doc: Remove typo of same word twice in a row. Rik <rik@octave.org> parents: 20207 diff changeset	4538 infinity are division by zero and overflow.\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	4539 \n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4540 @example\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4541 @group\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	4542 [ 1/0 e^800 ]\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	4543 @result{} Inf Inf\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4544 @end group\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4545 @end example\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4546 \n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4547 When called with no arguments, return a scalar with the value @samp{Inf}.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4548 \n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4549 When called with a single argument, return a square matrix with the dimension\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4550 specified.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4551 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4552 When called with more than one scalar argument the first two arguments are\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4553 taken as the number of rows and columns and any further arguments specify\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4554 additional matrix dimensions.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4555 \n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4556 The optional argument @var{class} specifies the return type and may be\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	4557 either @qcode{\"double\"} or @qcode{\"single\"}.\n\
15034 1116864ee270 doc: Fix for bad cross-referencing due to use of aliases in Texinfo. Rik <rik@octave.org> parents: 15031 diff changeset	4558 @seealso{isinf, NaN}\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4559 @end deftypefn")
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4560 {
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4561 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	4562 lo_ieee_float_inf_value (), "Inf");
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4563 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4564
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4565 DEFALIAS (inf, Inf);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4566
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4567 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4568 %!assert (inf (3), [Inf, Inf, Inf; Inf, Inf, Inf; Inf, Inf, Inf])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4569 %!assert (inf (2, 3), [Inf, Inf, Inf; Inf, Inf, Inf])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4570 %!assert (inf (3, 2), [Inf, Inf; Inf, Inf; Inf, Inf])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4571 %!assert (size (inf (3, 4, 5)), [3, 4, 5])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4572
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4573 %!assert (inf (3, "single"), single ([Inf, Inf, Inf; Inf, Inf, Inf; Inf, Inf, Inf]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4574 %!assert (inf (2, 3, "single"), single ([Inf, Inf, Inf; Inf, Inf, Inf]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4575 %!assert (inf (3, 2, "single"), single ([Inf, Inf; Inf, Inf; Inf, Inf]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4576 %!assert (size (inf (3, 4, 5, "single")), [3, 4, 5])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4577
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4578 %!error (inf (3, "int8"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4579 %!error (inf (2, 3, "int8"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4580 %!error (inf (3, 2, "int8"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4581 %!error (inf (3, 4, 5, "int8"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4582 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4583
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4584 DEFUN (NaN, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	4585 "-- texinfo --\n\
14171 2ced2f59f523 doc: miscellaneous documentation improvements Rik <octave@nomad.inbox5.com> parents: 14169 diff changeset	4586 @c List other form of function in documentation index\n\
2ced2f59f523 doc: miscellaneous documentation improvements Rik <octave@nomad.inbox5.com> parents: 14169 diff changeset	4587 @findex nan\n\
2ced2f59f523 doc: miscellaneous documentation improvements Rik <octave@nomad.inbox5.com> parents: 14169 diff changeset	4588 \n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4589 @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	4590 @deftypefnx {Built-in Function} {} NaN (@var{n})\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4591 @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	4592 @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	4593 @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	4594 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	4595 to the IEEE symbol NaN (Not a Number).\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4596 \n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4597 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	4598 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	4599 @tex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4600 ($\\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	4601 @end tex\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 8487 diff changeset	4602 @ifnottex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4603 (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	4604 @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	4605 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	4606 \n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4607 Note that NaN always compares not equal to NaN (NaN != NaN). This behavior\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4608 is specified by the IEEE standard for floating point arithmetic. To find\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4609 NaN values, use the @code{isnan} function.\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4610 \n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4611 When called with no arguments, return a scalar with the value @samp{NaN}.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4612 \n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4613 When called with a single argument, return a square matrix with the dimension\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4614 specified.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4615 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4616 When called with more than one scalar argument the first two arguments are\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4617 taken as the number of rows and columns and any further arguments specify\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4618 additional matrix dimensions.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4619 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4620 \n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4621 The optional argument @var{class} specifies the return type and may be\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	4622 either @qcode{\"double\"} or @qcode{\"single\"}.\n\
15034 1116864ee270 doc: Fix for bad cross-referencing due to use of aliases in Texinfo. Rik <rik@octave.org> parents: 15031 diff changeset	4623 @seealso{isnan, Inf}\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4624 @end deftypefn")
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4625 {
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4626 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	4627 lo_ieee_float_nan_value (), "NaN");
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4628 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4629
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4630 DEFALIAS (nan, NaN);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4631
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	4632 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4633 %!assert (NaN (3), [NaN, NaN, NaN; NaN, NaN, NaN; NaN, NaN, NaN])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4634 %!assert (NaN (2, 3), [NaN, NaN, NaN; NaN, NaN, NaN])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4635 %!assert (NaN (3, 2), [NaN, NaN; NaN, NaN; NaN, NaN])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4636 %!assert (size (NaN (3, 4, 5)), [3, 4, 5])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4637
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4638 %!assert (NaN (3, "single"), single ([NaN, NaN, NaN; NaN, NaN, NaN; NaN, NaN, NaN]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4639 %!assert (NaN (2, 3, "single"), single ([NaN, NaN, NaN; NaN, NaN, NaN]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4640 %!assert (NaN (3, 2, "single"), single ([NaN, NaN; NaN, NaN; NaN, NaN]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4641 %!assert (size (NaN (3, 4, 5, "single")), [3, 4, 5])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4642
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4643 %!error (NaN (3, "int8"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4644 %!error (NaN (2, 3, "int8"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4645 %!error (NaN (3, 2, "int8"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4646 %!error (NaN (3, 4, 5, "int8"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4647 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	4648
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4649 DEFUN (e, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	4650 "-- texinfo --\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4651 @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	4652 @deftypefnx {Built-in Function} {} e (@var{n})\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4653 @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	4654 @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	4655 @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	4656 Return a scalar, matrix, or N-dimensional array whose elements are all equal\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4657 to the base of natural logarithms.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4658 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4659 The constant\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4660 @tex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4661 $e$ satisfies the equation $\\log (e) = 1$.\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4662 @end tex\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 8487 diff changeset	4663 @ifnottex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4664 @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	4665 @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	4666 \n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4667 When called with no arguments, return a scalar with the value @math{e}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4668 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4669 When called with a single argument, return a square matrix with the dimension\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4670 specified.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4671 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4672 When called with more than one scalar argument the first two arguments are\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4673 taken as the number of rows and columns and any further arguments specify\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4674 additional matrix dimensions.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4675 \n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4676 The optional argument @var{class} specifies the return type and may be\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	4677 either @qcode{\"double\"} or @qcode{\"single\"}.\n\
15175 5984aa619cd9 doc: Remove multiple seealso links to I (bug #37046). Rik <rik@octave.org> parents: 15111 diff changeset	4678 @seealso{log, exp, pi, I}\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4679 @end deftypefn")
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4680 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4681 #if defined (M_E)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4682 double e_val = M_E;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4683 #else
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4684 double e_val = exp (1.0);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4685 #endif
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4686
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4687 return fill_matrix (args, e_val, "e");
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4688 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4689
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4690 DEFUN (eps, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	4691 "-- texinfo --\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4692 @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	4693 @deftypefnx {Built-in Function} {} eps (@var{x})\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4694 @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	4695 @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	4696 @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	4697 Return a scalar, matrix or N-dimensional array whose elements are all eps,\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4698 the machine precision.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4699 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4700 More precisely, @code{eps} is the relative spacing between any two adjacent\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4701 numbers in the machine's floating point system. This number is obviously\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4702 system dependent. On machines that support IEEE floating point arithmetic,\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4703 @code{eps} is approximately\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4704 @tex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4705 $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	4706 @end tex\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 8487 diff changeset	4707 @ifnottex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4708 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	4709 @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	4710 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	4711 \n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4712 When called with no arguments, return a scalar with the value\n\
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	4713 @code{eps (1.0)}.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4714 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4715 Given a single argument @var{x}, return the distance between @var{x} and the\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4716 next largest value.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4717 \n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4718 When called with more than one argument the first two arguments are taken as\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4719 the number of rows and columns and any further arguments specify additional\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4720 matrix dimensions. The optional argument @var{class} specifies the return\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4721 type and may be either @qcode{\"double\"} or @qcode{\"single\"}.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	4722 @seealso{realmax, realmin, intmax, bitmax}\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4723 @end deftypefn")
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4724 {
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4725 int nargin = args.length ();
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4726 octave_value retval;
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4727
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4728 if (nargin == 1 && ! args(0).is_string ())
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4729 {
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4730 if (args(0).is_single_type ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4731 {
15509 f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4732 Array<float> x = args(0).float_array_value ();
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4733
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4734 if (! error_state)
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	4735 {
15509 f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4736 Array<float> epsval (x.dims ());
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	4737
15509 f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4738 for (octave_idx_type i = 0; i < x.numel (); i++)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4739 {
15509 f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4740 float val = ::fabsf (x(i));
f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4741 if (xisnan (val) \|\| xisinf (val))
f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4742 epsval(i) = lo_ieee_nan_value ();
f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4743 else if (val < std::numeric_limits<float>::min ())
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	4744 epsval(i) = powf (2.0, -149e0);
15509 f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4745 else
f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4746 {
f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4747 int expon;
17843 573f865aa8c8 use gnulib frexp module John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	4748 gnulib::frexpf (val, &expon);
19772 9155bab86647 use 0.0f style constants instead of static_cast<float> (0.0) John W. Eaton <jwe@octave.org> parents: 19734 diff changeset	4749 epsval(i) = std::pow (2.0f,
19773 3fa35defe495 Adjust spacing of static_cast<> calls to follow Octave coding conventions. Rik <rik@octave.org> parents: 19772 diff changeset	4750 static_cast<float> (expon - 24));
15509 f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4751 }
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4752 }
15509 f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4753 retval = epsval;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4754 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4755 }
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4756 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4757 {
15509 f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4758 Array<double> x = args(0).array_value ();
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4759
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4760 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4761 {
15509 f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4762 Array<double> epsval (x.dims ());
f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4763
f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4764 for (octave_idx_type i = 0; i < x.numel (); i++)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4765 {
15509 f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4766 double val = ::fabs (x(i));
f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4767 if (xisnan (val) \|\| xisinf (val))
f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4768 epsval(i) = lo_ieee_nan_value ();
f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4769 else if (val < std::numeric_limits<double>::min ())
f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4770 epsval(i) = pow (2.0, -1074e0);
f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4771 else
f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4772 {
f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4773 int expon;
17843 573f865aa8c8 use gnulib frexp module John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	4774 gnulib::frexp (val, &expon);
19773 3fa35defe495 Adjust spacing of static_cast<> calls to follow Octave coding conventions. Rik <rik@octave.org> parents: 19772 diff changeset	4775 epsval(i) = std::pow (2.0,
3fa35defe495 Adjust spacing of static_cast<> calls to follow Octave coding conventions. Rik <rik@octave.org> parents: 19772 diff changeset	4776 static_cast<double> (expon - 53));
15509 f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4777 }
f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4778 retval = epsval;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4779 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4780 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	4781 }
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4782 }
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4783 else
15213 336f42406671 use numeric_limits functions instead of DBL_MIN, DBL_MAX, etc. John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	4784 retval = fill_matrix (args, std::numeric_limits<double>::epsilon (),
336f42406671 use numeric_limits functions instead of DBL_MIN, DBL_MAX, etc. John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	4785 std::numeric_limits<float>::epsilon (), "eps");
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4786
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4787 return retval;
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4788 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4789
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4790 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4791 %!assert (eps (1/2), 2^(-53))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4792 %!assert (eps (1), 2^(-52))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4793 %!assert (eps (2), 2^(-51))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4794 %!assert (eps (realmax), 2^971)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4795 %!assert (eps (0), 2^(-1074))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4796 %!assert (eps (realmin/2), 2^(-1074))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4797 %!assert (eps (realmin/16), 2^(-1074))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4798 %!assert (eps (Inf), NaN)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4799 %!assert (eps (NaN), NaN)
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	4800 %!assert (eps ([1/2 1 2 realmax 0 realmin/2 realmin/16 Inf NaN]),
15509 f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4801 %! [2^(-53) 2^(-52) 2^(-51) 2^971 2^(-1074) 2^(-1074) 2^(-1074) NaN NaN])
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4802 %!assert (eps (single (1/2)), single (2^(-24)))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4803 %!assert (eps (single (1)), single (2^(-23)))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4804 %!assert (eps (single (2)), single (2^(-22)))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4805 %!assert (eps (realmax ("single")), single (2^104))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4806 %!assert (eps (single (0)), single (2^(-149)))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4807 %!assert (eps (realmin ("single")/2), single (2^(-149)))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4808 %!assert (eps (realmin ("single")/16), single (2^(-149)))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4809 %!assert (eps (single (Inf)), single (NaN))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	4810 %!assert (eps (single (NaN)), single (NaN))
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	4811 %!assert (eps (single ([1/2 1 2 realmax("single") 0 realmin("single")/2 realmin("single")/16 Inf NaN])),
15509 f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4812 %! single ([2^(-24) 2^(-23) 2^(-22) 2^104 2^(-149) 2^(-149) 2^(-149) NaN NaN]))
f0dfdc7faa71 Fix incorrect behaviour of eps () for matrix input (bug #37539). Carlo de Falco <cdf@users.sourceforge.net> parents: 15467 diff changeset	4813
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4814 */
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7789 diff changeset	4815
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4816 DEFUN (pi, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	4817 "-- texinfo --\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4818 @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	4819 @deftypefnx {Built-in Function} {} pi (@var{n})\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4820 @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	4821 @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	4822 @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	4823 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	4824 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	4825 @tex\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4826 diameter($\\pi$).\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4827 @end tex\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4828 @ifnottex\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4829 diameter.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4830 @end ifnottex\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4831 \n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4832 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	4833 \n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4834 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	4835 @tex\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4836 $\\pi$.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4837 @end tex\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4838 @ifnottex\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4839 pi.\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4840 @end ifnottex\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4841 \n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4842 When called with a single argument, return a square matrix with the dimension\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4843 specified.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4844 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4845 When called with more than one scalar argument the first two arguments are\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4846 taken as the number of rows and columns and any further arguments specify\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4847 additional matrix dimensions.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4848 \n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4849 The optional argument @var{class} specifies the return type and may be\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	4850 either @qcode{\"double\"} or @qcode{\"single\"}.\n\
15175 5984aa619cd9 doc: Remove multiple seealso links to I (bug #37046). Rik <rik@octave.org> parents: 15111 diff changeset	4851 @seealso{e, I}\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4852 @end deftypefn")
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4853 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4854 #if defined (M_PI)
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4855 double pi_val = M_PI;
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4856 #else
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4857 double pi_val = 4.0 * atan (1.0);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4858 #endif
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4859
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4860 return fill_matrix (args, pi_val, "pi");
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4861 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4862
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4863 DEFUN (realmax, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	4864 "-- texinfo --\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4865 @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	4866 @deftypefnx {Built-in Function} {} realmax (@var{n})\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4867 @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	4868 @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	4869 @deftypefnx {Built-in Function} {} realmax (@dots{}, @var{class})\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4870 Return a scalar, matrix, or N-dimensional array whose elements are all equal\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4871 to the largest floating point number that is representable.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4872 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4873 The actual 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	4874 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	4875 @tex\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4876 $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	4877 @end tex\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 8487 diff changeset	4878 @ifnottex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4879 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	4880 @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	4881 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	4882 \n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4883 When called with no arguments, return a scalar with the value\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	4884 @code{realmax (@qcode{\"double\"})}.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4885 \n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4886 When called with a single argument, return a square matrix with the dimension\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4887 specified.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4888 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4889 When called with more than one scalar argument the first two arguments are\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4890 taken as the number of rows and columns and any further arguments specify\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4891 additional matrix dimensions.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4892 \n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4893 The optional argument @var{class} specifies the return type and may be\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	4894 either @qcode{\"double\"} or @qcode{\"single\"}.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	4895 @seealso{realmin, intmax, bitmax, eps}\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4896 @end deftypefn")
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4897 {
15213 336f42406671 use numeric_limits functions instead of DBL_MIN, DBL_MAX, etc. John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	4898 return fill_matrix (args, std::numeric_limits<double>::max (),
336f42406671 use numeric_limits functions instead of DBL_MIN, DBL_MAX, etc. John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	4899 std::numeric_limits<float>::max (), "realmax");
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4900 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4901
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4902 DEFUN (realmin, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	4903 "-- texinfo --\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4904 @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	4905 @deftypefnx {Built-in Function} {} realmin (@var{n})\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4906 @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	4907 @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	4908 @deftypefnx {Built-in Function} {} realmin (@dots{}, @var{class})\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4909 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	4910 to the smallest normalized floating point number that is representable.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4911 \n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4912 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	4913 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	4914 @tex\n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4915 $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	4916 @end tex\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 8487 diff changeset	4917 @ifnottex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4918 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	4919 @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	4920 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	4921 \n\
3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4922 When called with no arguments, return a scalar with the value\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	4923 @code{realmin (@qcode{\"double\"})}.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4924 \n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4925 When called with a single argument, return a square matrix with the dimension\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4926 specified.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4927 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4928 When called with more than one scalar argument the first two arguments are\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4929 taken as the number of rows and columns and any further arguments specify\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4930 additional matrix dimensions.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4931 \n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4932 The optional argument @var{class} specifies the return type and may be\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	4933 either @qcode{\"double\"} or @qcode{\"single\"}.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	4934 @seealso{realmax, intmin, eps}\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4935 @end deftypefn")
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4936 {
15213 336f42406671 use numeric_limits functions instead of DBL_MIN, DBL_MAX, etc. John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	4937 return fill_matrix (args, std::numeric_limits<double>::min (),
336f42406671 use numeric_limits functions instead of DBL_MIN, DBL_MAX, etc. John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	4938 std::numeric_limits<float>::min (), "realmin");
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4939 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4940
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4941 DEFUN (I, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	4942 "-- texinfo --\n\
14100 8a2dc08886ea Fix Info referencing for i, I, j, J (Bug #35157) Rik <octave@nomad.inbox5.com> parents: 14085 diff changeset	4943 @c List other forms of function in documentation index\n\
8a2dc08886ea Fix Info referencing for i, I, j, J (Bug #35157) Rik <octave@nomad.inbox5.com> parents: 14085 diff changeset	4944 @findex i\n\
8a2dc08886ea Fix Info referencing for i, I, j, J (Bug #35157) Rik <octave@nomad.inbox5.com> parents: 14085 diff changeset	4945 @findex j\n\
8a2dc08886ea Fix Info referencing for i, I, j, J (Bug #35157) Rik <octave@nomad.inbox5.com> parents: 14085 diff changeset	4946 @findex J\n\
8a2dc08886ea Fix Info referencing for i, I, j, J (Bug #35157) Rik <octave@nomad.inbox5.com> parents: 14085 diff changeset	4947 \n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4948 @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	4949 @deftypefnx {Built-in Function} {} I (@var{n})\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4950 @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	4951 @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	4952 @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	4953 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	4954 to the pure imaginary unit, defined as\n\
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4955 @tex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4956 $\\sqrt{-1}$.\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4957 @end tex\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 8487 diff changeset	4958 @ifnottex\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4959 @code{sqrt (-1)}.\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 8487 diff changeset	4960 @end ifnottex\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	4961 \n\
15034 1116864ee270 doc: Fix for bad cross-referencing due to use of aliases in Texinfo. Rik <rik@octave.org> parents: 15031 diff changeset	4962 I, and its equivalents i, j, and J, are functions so any of the names may\n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4963 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	4964 \n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4965 When called with no arguments, return a scalar with the value @math{i}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4966 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4967 When called with a single argument, return a square matrix with the dimension\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4968 specified.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4969 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4970 When called with more than one scalar argument the first two arguments are\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4971 taken as the number of rows and columns and any further arguments specify\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4972 additional matrix dimensions.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	4973 \n\
9197 3c27a0340a64 Update documentation for section 17.8 (Mathematical Constants) of arith.texi Rik <rdrider0-list@yahoo.com> parents: 9194 diff changeset	4974 The optional argument @var{class} specifies the return type and may be\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	4975 either @qcode{\"double\"} or @qcode{\"single\"}.\n\
15175 5984aa619cd9 doc: Remove multiple seealso links to I (bug #37046). Rik <rik@octave.org> parents: 15111 diff changeset	4976 @seealso{e, pi, log, exp}\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4977 @end deftypefn")
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4978 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4979 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	4980 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4981
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4982 DEFALIAS (i, I);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4983 DEFALIAS (J, I);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4984 DEFALIAS (j, I);
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4985
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4986 DEFUN (NA, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	4987 "-- texinfo --\n\
9308 f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	4988 @deftypefn {Built-in Function} {} NA\n\
f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	4989 @deftypefnx {Built-in Function} {} NA (@var{n})\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	4990 @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	4991 @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	4992 @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	4993 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	4994 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	4995 \n\
f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	4996 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	4997 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	4998 \n\
f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	4999 When called with no arguments, return a scalar with the value @samp{NA}.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5000 \n\
9308 f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	5001 When called with a single argument, return a square matrix with the dimension\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5002 specified.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5003 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5004 When called with more than one scalar argument the first two arguments are\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5005 taken as the number of rows and columns and any further arguments specify\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5006 additional matrix dimensions.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5007 \n\
9308 f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	5008 The optional argument @var{class} specifies the return type and may be\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	5009 either @qcode{\"double\"} or @qcode{\"single\"}.\n\
9308 f2bf62f62286 Update documentation for NA and isna functions Rik <rdrider0-list@yahoo.com> parents: 9198 diff changeset	5010 @seealso{isna}\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5011 @end deftypefn")
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5012 {
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	5013 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	5014 lo_ieee_float_na_value (), "NA");
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5015 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5016
7991 139f47cf17ab Change NA value to support single to double precision conversion David Bateman <dbateman@free.fr> parents: 7919 diff changeset	5017 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5018 %!assert (single (NA ("double")), NA ("single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5019 %!assert (double (NA ("single")), NA ("double"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5020 */
7991 139f47cf17ab Change NA value to support single to double precision conversion David Bateman <dbateman@free.fr> parents: 7919 diff changeset	5021
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5022 DEFUN (false, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	5023 "-- texinfo --\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	5024 @deftypefn {Built-in Function} {} false (@var{x})\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5025 @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	5026 @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	5027 Return a matrix or N-dimensional array whose elements are all logical 0.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5028 \n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	5029 If invoked with a single scalar integer argument, return a square\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5030 matrix of the specified size.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5031 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5032 If invoked with two or more scalar integer arguments, or a vector of integer\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5033 values, return an array with given dimensions.\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	5034 @seealso{true}\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5035 @end deftypefn")
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5036 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5037 return fill_matrix (args, false, "false");
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5038 }
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5039
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5040 DEFUN (true, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	5041 "-- texinfo --\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	5042 @deftypefn {Built-in Function} {} true (@var{x})\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5043 @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	5044 @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	5045 Return a matrix or N-dimensional array whose elements are all logical 1.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5046 \n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	5047 If invoked with a single scalar integer argument, return a square\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5048 matrix of the specified size.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5049 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5050 If invoked with two or more scalar integer arguments, or a vector of integer\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5051 values, return an array with given dimensions.\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	5052 @seealso{false}\n\
5747 b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5053 @end deftypefn")
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5054 {
b09d4d0f5b63 [project @ 2006-04-07 06:43:10 by jwe] jwe parents: 5734 diff changeset	5055 return fill_matrix (args, true, "true");
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	5056 }
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5057
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5058 template <class MT>
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5059 octave_value
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5060 identity_matrix (int nr, int nc)
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5061 {
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5062 octave_value retval;
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5063
9685 e793865ede63 implement builtin_type Jaroslav Hajek <highegg@gmail.com> parents: 9658 diff changeset	5064 typename MT::element_type one (1);
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5065
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5066 if (nr == 1 && nc == 1)
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5067 retval = one;
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5068 else
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5069 {
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5070 dim_vector dims (nr, nc);
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5071
9685 e793865ede63 implement builtin_type Jaroslav Hajek <highegg@gmail.com> parents: 9658 diff changeset	5072 typename MT::element_type zero (0);
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5073
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5074 MT m (dims, zero);
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5075
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5076 if (nr > 0 && nc > 0)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5077 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5078 int n = std::min (nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5079
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5080 for (int i = 0; i < n; i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5081 m(i,i) = one;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5082 }
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5083
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5084 retval = m;
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5085 }
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5086
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5087 return retval;
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5088 }
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5089
5058 11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5090 #define INSTANTIATE_EYE(T) \
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5091 template octave_value identity_matrix<T> (int, int)
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5092
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5093 INSTANTIATE_EYE (int8NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5094 INSTANTIATE_EYE (uint8NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5095 INSTANTIATE_EYE (int16NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5096 INSTANTIATE_EYE (uint16NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5097 INSTANTIATE_EYE (int32NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5098 INSTANTIATE_EYE (uint32NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5099 INSTANTIATE_EYE (int64NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5100 INSTANTIATE_EYE (uint64NDArray);
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7743 diff changeset	5101 INSTANTIATE_EYE (FloatNDArray);
5058 11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5102 INSTANTIATE_EYE (NDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5103 INSTANTIATE_EYE (boolNDArray);
11bea7392e69 [project @ 2004-11-01 21:06:44 by jwe] jwe parents: 5013 diff changeset	5104
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5105 static octave_value
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	5106 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	5107 {
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5108 octave_value retval;
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5109
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	5110 // 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	5111 // 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	5112 // value.
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5113
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5114 if (! error_state)
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5115 {
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5116 switch (dt)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5117 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5118 case oct_data_conv::dt_int8:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5119 retval = identity_matrix<int8NDArray> (nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5120 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5121
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5122 case oct_data_conv::dt_uint8:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5123 retval = identity_matrix<uint8NDArray> (nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5124 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5125
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5126 case oct_data_conv::dt_int16:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5127 retval = identity_matrix<int16NDArray> (nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5128 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5129
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5130 case oct_data_conv::dt_uint16:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5131 retval = identity_matrix<uint16NDArray> (nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5132 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5133
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5134 case oct_data_conv::dt_int32:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5135 retval = identity_matrix<int32NDArray> (nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5136 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5137
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5138 case oct_data_conv::dt_uint32:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5139 retval = identity_matrix<uint32NDArray> (nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5140 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5141
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5142 case oct_data_conv::dt_int64:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5143 retval = identity_matrix<int64NDArray> (nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5144 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5145
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5146 case oct_data_conv::dt_uint64:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5147 retval = identity_matrix<uint64NDArray> (nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5148 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5149
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5150 case oct_data_conv::dt_single:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5151 retval = FloatDiagMatrix (nr, nc, 1.0f);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5152 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5153
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5154 case oct_data_conv::dt_double:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5155 retval = DiagMatrix (nr, nc, 1.0);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5156 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5157
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5158 case oct_data_conv::dt_logical:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5159 retval = identity_matrix<boolNDArray> (nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5160 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5161
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5162 default:
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5163 error ("eye: invalid class name");
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5164 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5165 }
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5166 }
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5167
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5168 return retval;
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5169 }
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5170
4946 48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5171 #undef INT_EYE_MATRIX
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe] jwe parents: 4945 diff changeset	5172
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	5173 DEFUN (eye, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	5174 "-- texinfo --\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5175 @deftypefn {Built-in Function} {} eye (@var{n})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5176 @deftypefnx {Built-in Function} {} eye (@var{m}, @var{n})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5177 @deftypefnx {Built-in Function} {} eye ([@var{m} @var{n}])\n\
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	5178 @deftypefnx {Built-in Function} {} eye (@dots{}, @var{class})\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5179 Return an identity matrix.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5180 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5181 If invoked with a single scalar argument @var{n}, return a square\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5182 @nospell{NxN} identity matrix.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5183 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5184 If supplied two scalar arguments (@var{m}, @var{n}), @code{eye} takes them\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5185 to be the number of rows and columns. If given a vector with two elements,\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5186 @code{eye} uses the values of the elements as the number of rows and\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5187 columns, respectively. For example:\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	5188 \n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	5189 @example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	5190 @group\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	5191 eye (3)\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	5192 @result{} 1 0 0\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	5193 0 1 0\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	5194 0 0 1\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	5195 @end group\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	5196 @end example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	5197 \n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	5198 The following expressions all produce the same result:\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	5199 \n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	5200 @example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	5201 @group\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	5202 eye (2)\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	5203 @equiv{}\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	5204 eye (2, 2)\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	5205 @equiv{}\n\
18713 a142f35f3cb6 doc: Fix unbalanced parentheses in documentation. Rik <rik@octave.org> parents: 18712 diff changeset	5206 eye (size ([1, 2; 3, 4]))\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	5207 @end group\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	5208 @end example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	5209 \n\
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5210 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	5211 the specified type, like\n\
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5212 \n\
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5213 @example\n\
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5214 val = zeros (n,m, \"uint8\")\n\
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5215 @end example\n\
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5216 \n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5217 Calling @code{eye} with no arguments is equivalent to calling it with an\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5218 argument of 1. Any negative dimensions are treated as zero. These odd\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5219 definitions are for compatibility with @sc{matlab}.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	5220 @seealso{speye, ones, zeros}\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	5221 @end deftypefn")
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5222 {
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	5223 octave_value retval;
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5224
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	5225 int nargin = args.length ();
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5226
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	5227 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	5228
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5229 // Check for type information.
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5230
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5231 if (nargin > 0 && args(nargin-1).is_string ())
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5232 {
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	5233 std::string nm = args(nargin-1).string_value ();
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5234 nargin--;
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	5235
7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	5236 dt = oct_data_conv::string_to_data_type (nm);
7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	5237
7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	5238 if (error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5239 return retval;
4945 4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5240 }
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe] jwe parents: 4915 diff changeset	5241
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5242 switch (nargin)
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5243 {
712 36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	5244 case 0:
4948 7124436476cb [project @ 2004-08-31 17:57:21 by jwe] jwe parents: 4947 diff changeset	5245 retval = identity_matrix (1, 1, dt);
712 36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 649 diff changeset	5246 break;
777 a2f9d3fd720c [project @ 1994-10-07 14:01:53 by jwe] jwe parents: 767 diff changeset	5247
610 14b2a186a5c0 [project @ 1994-08-14 00:55:49 by jwe] jwe parents: 597 diff changeset	5248 case 1:
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	5249 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5250 octave_idx_type nr, nc;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5251 get_dimensions (args(0), "eye", nr, nc);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5252
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5253 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5254 retval = identity_matrix (nr, nc, dt);
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	5255 }
610 14b2a186a5c0 [project @ 1994-08-14 00:55:49 by jwe] jwe parents: 597 diff changeset	5256 break;
777 a2f9d3fd720c [project @ 1994-10-07 14:01:53 by jwe] jwe parents: 767 diff changeset	5257
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5258 case 2:
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	5259 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5260 octave_idx_type nr, nc;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5261 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	5262
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5263 if (! error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5264 retval = identity_matrix (nr, nc, dt);
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3333 diff changeset	5265 }
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5266 break;
777 a2f9d3fd720c [project @ 1994-10-07 14:01:53 by jwe] jwe parents: 767 diff changeset	5267
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5268 default:
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	5269 print_usage ();
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5270 break;
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5271 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5272
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5273 return retval;
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5274 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5275
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5276 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5277 %!assert (full (eye (3)), [1, 0, 0; 0, 1, 0; 0, 0, 1])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5278 %!assert (full (eye (2, 3)), [1, 0, 0; 0, 1, 0])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5279
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5280 %!assert (full (eye (3,"single")), single ([1, 0, 0; 0, 1, 0; 0, 0, 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5281 %!assert (full (eye (2, 3,"single")), single ([1, 0, 0; 0, 1, 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5282
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5283 %!assert (eye (3, "int8"), int8 ([1, 0, 0; 0, 1, 0; 0, 0, 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5284 %!assert (eye (2, 3, "int8"), int8 ([1, 0, 0; 0, 1, 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5285
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5286 %!error eye (1, 2, 3)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5287 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5288
9658 3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5289 template <class MT>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	5290 static octave_value
9658 3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5291 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	5292 octave_idx_type n)
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5293 {
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5294 typedef typename MT::column_vector_type CVT;
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5295 typedef typename MT::element_type T;
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5296
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5297 octave_value retval;
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5298
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5299 if (base.is_scalar_type ())
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5300 {
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5301 T bs = octave_value_extract<T> (base);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5302 if (limit.is_scalar_type ())
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5303 {
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5304 T ls = octave_value_extract<T> (limit);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5305 retval = linspace (bs, ls, n);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5306 }
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5307 else
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5308 {
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5309 CVT lv = octave_value_extract<CVT> (limit);
20267 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20253 diff changeset	5310 CVT bv (lv.numel (), bs);
9658 3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5311 retval = linspace (bv, lv, n);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5312 }
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5313 }
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5314 else
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5315 {
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5316 CVT bv = octave_value_extract<CVT> (base);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5317 if (limit.is_scalar_type ())
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5318 {
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5319 T ls = octave_value_extract<T> (limit);
20267 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20253 diff changeset	5320 CVT lv (bv.numel (), ls);
9658 3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5321 retval = linspace (bv, lv, n);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5322 }
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5323 else
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5324 {
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5325 CVT lv = octave_value_extract<CVT> (limit);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5326 retval = linspace (bv, lv, n);
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5327 }
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5328 }
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5329
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5330 return retval;
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5331 }
3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5332
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1940 diff changeset	5333 DEFUN (linspace, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	5334 "-- texinfo --\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5335 @deftypefn {Built-in Function} {} linspace (@var{base}, @var{limit})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5336 @deftypefnx {Built-in Function} {} linspace (@var{base}, @var{limit}, @var{n})\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	5337 Return a row vector with @var{n} linearly spaced elements between\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5338 @var{base} and @var{limit}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5339 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5340 If the number of elements is greater than one, then the endpoints @var{base}\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5341 and @var{limit} are always included in the range. If @var{base} is greater\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5342 than @var{limit}, the elements are stored in decreasing order. If the\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5343 number of points is not specified, a value of 100 is used.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5344 \n\
20501 16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5345 The @code{linspace} function returns a row vector when both @var{base}\n\
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5346 and @var{limit} are scalars. If one, or both, inputs are vectors, then\n\
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5347 @code{linspace} transforms them to column vectors and returns a matrix where\n\
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5348 each row is an independent sequence between\n\
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5349 @w{@code{@var{base}(@var{row_n}), @var{limit}(@var{row_n})}}.\n\
6630 0fcc8d65b571 [project @ 2007-05-16 15:32:09 by jwe] jwe parents: 6561 diff changeset	5350 \n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5351 For compatibility with @sc{matlab}, return the second argument (@var{limit})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5352 if fewer than two values are requested.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	5353 @seealso{logspace}\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3361 diff changeset	5354 @end deftypefn")
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5355 {
3418 ca92c9d3f882 [project @ 2000-01-12 03:07:47 by jwe] jwe parents: 3373 diff changeset	5356 octave_value retval;
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5357
3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5358 int nargin = args.length ();
3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5359
6133 e0065af38cf4 [project @ 2006-11-02 03:33:50 by jwe] jwe parents: 5991 diff changeset	5360 octave_idx_type npoints = 100;
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5361
1940 1b193e313c56 [project @ 1996-02-13 16:28:47 by jwe] jwe parents: 1884 diff changeset	5362 if (nargin != 2 && nargin != 3)
1b193e313c56 [project @ 1996-02-13 16:28:47 by jwe] jwe parents: 1884 diff changeset	5363 {
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	5364 print_usage ();
1940 1b193e313c56 [project @ 1996-02-13 16:28:47 by jwe] jwe parents: 1884 diff changeset	5365 return retval;
1b193e313c56 [project @ 1996-02-13 16:28:47 by jwe] jwe parents: 1884 diff changeset	5366 }
1b193e313c56 [project @ 1996-02-13 16:28:47 by jwe] jwe parents: 1884 diff changeset	5367
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5368 if (nargin == 3)
16077 39129305b914 provide some undocumented matlab behavior for linspace (bug #38151) John W. Eaton <jwe@octave.org> parents: 15623 diff changeset	5369 {
39129305b914 provide some undocumented matlab behavior for linspace (bug #38151) John W. Eaton <jwe@octave.org> parents: 15623 diff changeset	5370 // Apparently undocumented Matlab. If the third arg is an empty
39129305b914 provide some undocumented matlab behavior for linspace (bug #38151) John W. Eaton <jwe@octave.org> parents: 15623 diff changeset	5371 // numeric value, the number of points defaults to 1.
39129305b914 provide some undocumented matlab behavior for linspace (bug #38151) John W. Eaton <jwe@octave.org> parents: 15623 diff changeset	5372
39129305b914 provide some undocumented matlab behavior for linspace (bug #38151) John W. Eaton <jwe@octave.org> parents: 15623 diff changeset	5373 octave_value arg_3 = args(2);
39129305b914 provide some undocumented matlab behavior for linspace (bug #38151) John W. Eaton <jwe@octave.org> parents: 15623 diff changeset	5374
39129305b914 provide some undocumented matlab behavior for linspace (bug #38151) John W. Eaton <jwe@octave.org> parents: 15623 diff changeset	5375 if (arg_3.is_numeric_type () && arg_3.is_empty ())
39129305b914 provide some undocumented matlab behavior for linspace (bug #38151) John W. Eaton <jwe@octave.org> parents: 15623 diff changeset	5376 npoints = 1;
20501 16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5377 else if (! arg_3.is_scalar_type ())
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5378 error ("linspace: N must be a scalar");
16077 39129305b914 provide some undocumented matlab behavior for linspace (bug #38151) John W. Eaton <jwe@octave.org> parents: 15623 diff changeset	5379 else
39129305b914 provide some undocumented matlab behavior for linspace (bug #38151) John W. Eaton <jwe@octave.org> parents: 15623 diff changeset	5380 npoints = arg_3.idx_type_value ();
39129305b914 provide some undocumented matlab behavior for linspace (bug #38151) John W. Eaton <jwe@octave.org> parents: 15623 diff changeset	5381 }
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5382
3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5383 if (! error_state)
3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5384 {
3322 8c6b4de3bdc8 [project @ 1999-10-26 21:33:27 by jwe] jwe parents: 3321 diff changeset	5385 octave_value arg_1 = args(0);
8c6b4de3bdc8 [project @ 1999-10-26 21:33:27 by jwe] jwe parents: 3321 diff changeset	5386 octave_value arg_2 = args(1);
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5387
20501 16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5388 dim_vector sz1 = arg_1.dims ();
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5389 bool isvector1 = sz1.length () == 2 && (sz1(0) == 1 \|\| sz1(1) == 1);
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5390 dim_vector sz2 = arg_2.dims ();
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5391 bool isvector2 = sz2.length () == 2 && (sz2(0) == 1 \|\| sz2(1) == 1);
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5392
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5393 if (! isvector1 \|\| ! isvector2)
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5394 error ("linspace: A, B must be scalars or vectors");
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5395 else 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	5396 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5397 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	5398 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	5399 else
9658 3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5400 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	5401
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5402 }
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5403 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5404 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5405 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	5406 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	5407 else
9658 3429c956de6f extend linspace & fix up liboctave rewrite Jaroslav Hajek <highegg@gmail.com> parents: 9562 diff changeset	5408 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	5409 }
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5410 }
4732 b484cdca27be [project @ 2004-02-04 04:32:48 by jwe] jwe parents: 4685 diff changeset	5411 else
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	5412 error ("linspace: N must be an integer");
1100 3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5413
3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5414 return retval;
3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5415 }
3b6f6c5217e7 [project @ 1995-02-14 01:45:09 by jwe] jwe parents: 1032 diff changeset	5416
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5417
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5418 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5419 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5420 %! 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	5421 %! 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	5422 %! x3 = linspace (1, -2, 10);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5423 %! assert (size (x1) == [1, 100] && x1(1) == 1 && x1(100) == 2);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5424 %! assert (size (x2) == [1, 10] && x2(1) == 1 && x2(10) == 2);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5425 %! assert (size (x3) == [1, 10] && x3(1) == 1 && x3(10) == -2);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5426
20501 16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5427 ## Test complex values
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5428 %!test
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5429 %! exp = [1+0i, 2-1.25i, 3-2.5i, 4-3.75i, 5-5i];
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5430 %! obs = linspace (1, 5-5i, 5);
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5431 %! assert (obs, exp);
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5432
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5433 ## Test class of output
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5434 %!assert (class (linspace (1, 2)), "double")
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5435 %!assert (class (linspace (single (1), 2)), "single")
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5436 %!assert (class (linspace (1, single (2))), "single")
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5437
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5438 ## Test obscure Matlab compatibility options
17206 ea5830dc6b19 test: Correct typo '%assert' -> '%!assert' to have test blocks run. Rik <rik@octave.org> parents: 17115 diff changeset	5439 %!assert (linspace (0, 1, []), 1)
20501 16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5440 %!assert (linspace (10, 20, 2), [10 20])
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5441 %!assert (linspace (10, 20, 1), [20])
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5442 %!assert (linspace (10, 20, 0), zeros (1, 0))
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5443 %!assert (linspace (10, 20, -1), zeros (1, 0))
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5444 %!assert (numel (linspace (0, 1, 2+eps)), 2)
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5445 %!assert (numel (linspace (0, 1, 2-eps)), 1)
16077 39129305b914 provide some undocumented matlab behavior for linspace (bug #38151) John W. Eaton <jwe@octave.org> parents: 15623 diff changeset	5446
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5447 %!error linspace ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5448 %!error linspace (1, 2, 3, 4)
20501 16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5449 %!error <N must be a scalar> linspace (1, 2, [3, 4])
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5450 %!error <must be scalars or vectors> linspace (ones (2,2), 2, 3)
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5451 %!error <must be scalars or vectors> linspace (2, ones (2,2), 3)
16b9ec39ff46 Return empty matrix when linspace called with 0 points (bug #45820) Rik <rik@octave.org> parents: 20440 diff changeset	5452 %!error <must be scalars or vectors> linspace (1, [], 3)
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5453 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5454
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	5455 // 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	5456 // 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	5457
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5458 DEFUN (resize, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	5459 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	5460 @deftypefn {Built-in Function} {} resize (@var{x}, @var{m})\n\
8799 f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5461 @deftypefnx {Built-in Function} {} resize (@var{x}, @var{m}, @var{n}, @dots{})\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5462 @deftypefnx {Built-in Function} {} resize (@var{x}, [@var{m} @var{n} @dots{}])\n\
8799 f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5463 Resize @var{x} cutting off elements as necessary.\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5464 \n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5465 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	5466 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	5467 otherwise, the element is set to zero.\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5468 \n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5469 In other words, the statement\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5470 \n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5471 @example\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	5472 y = resize (x, dv)\n\
8799 f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5473 @end example\n\
6174 d3c599afc455 [project @ 2006-11-16 17:52:02 by jwe] jwe parents: 6156 diff changeset	5474 \n\
8799 f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5475 @noindent\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5476 is equivalent to the following code:\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5477 \n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5478 @example\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	5479 @group\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	5480 y = zeros (dv, class (x));\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	5481 sz = min (dv, size (x));\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	5482 for i = 1:length (sz)\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	5483 idx@{i@} = 1:sz(i);\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	5484 endfor\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	5485 y(idx@{:@}) = x(idx@{:@});\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	5486 @end group\n\
8799 f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5487 @end example\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5488 \n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5489 @noindent\n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5490 but is performed more efficiently.\n\
6174 d3c599afc455 [project @ 2006-11-16 17:52:02 by jwe] jwe parents: 6156 diff changeset	5491 \n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5492 If only @var{m} is supplied, and it is a scalar, the dimension of the\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5493 result is @var{m}-by-@var{m}.\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5494 If @var{m}, @var{n}, @dots{} are all scalars, then the dimensions of\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5495 the result are @var{m}-by-@var{n}-by-@dots{}.\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5496 If given a vector as input, then the\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5497 dimensions of the result are given by the elements of that vector.\n\
8799 f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5498 \n\
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5499 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	5500 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	5501 Resizing an object to fewer dimensions is not possible.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	5502 @seealso{reshape, postpad, prepad, cat}\n\
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5503 @end deftypefn")
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5504 {
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5505 octave_value retval;
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5506 int nargin = args.length ();
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5507
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5508 if (nargin == 2)
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5509 {
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5510 Array<double> vec = args(1).vector_value ();
20267 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20253 diff changeset	5511 int ndim = vec.numel ();
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5512 if (ndim == 1)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5513 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5514 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	5515 retval = args(0);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5516 retval = retval.resize (dim_vector (m, m), true);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5517 }
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5518 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5519 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5520 dim_vector dv;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5521 dv.resize (ndim);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5522 for (int i = 0; i < ndim; i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5523 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	5524 retval = args(0);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5525 retval = retval.resize (dv, true);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5526 }
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5527 }
8799 f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5528 else if (nargin > 2)
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5529 {
8799 f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5530 dim_vector dv;
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5531 dv.resize (nargin - 1);
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5532 for (octave_idx_type i = 1; i < nargin; i++)
f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5533 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	5534 if (!error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5535 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5536 retval = args(0);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5537 retval = retval.resize (dv, true);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5538 }
8799 f6dc6eb57045 improve resize & resize on assignment Jaroslav Hajek <highegg@gmail.com> parents: 8780 diff changeset	5539
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5540 }
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5541 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	5542 print_usage ();
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5543 return retval;
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5544 }
c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5724 diff changeset	5545
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	5546 // FIXME: should use octave_idx_type for dimensions.
5734 a7d2c47371d2 [project @ 2006-04-04 18:29:13 by jwe] jwe parents: 5731 diff changeset	5547
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5548 DEFUN (reshape, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	5549 "-- texinfo --\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5550 @deftypefn {Built-in Function} {} reshape (@var{A}, @var{m}, @var{n}, @dots{})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5551 @deftypefnx {Built-in Function} {} reshape (@var{A}, [@var{m} @var{n} @dots{}])\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5552 @deftypefnx {Built-in Function} {} reshape (@var{A}, @dots{}, [], @dots{})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5553 @deftypefnx {Built-in Function} {} reshape (@var{A}, @var{size})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5554 Return a matrix with the specified dimensions (@var{m}, @var{n}, @dots{})\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5555 whose elements are taken from the matrix @var{A}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5556 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5557 The elements of the matrix are accessed in column-major order (like Fortran\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5558 arrays are stored).\n\
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5559 \n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5560 The following code demonstrates reshaping a 1x4 row vector into a 2x2 square\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5561 matrix.\n\
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5562 \n\
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5563 @example\n\
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5564 @group\n\
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5565 reshape ([1, 2, 3, 4], 2, 2)\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	5566 @result{} 1 3\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	5567 2 4\n\
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5568 @end group\n\
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5569 @end example\n\
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5570 \n\
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5571 @noindent\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5572 Note that the total number of elements in the original matrix\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5573 (@code{prod (size (@var{A}))}) must match the total number of elements\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5574 in the new matrix (@code{prod ([@var{m} @var{n} @dots{}])}).\n\
5013 1eb9ce5c0152 [project @ 2004-09-21 22:18:07 by jwe] jwe parents: 4986 diff changeset	5575 \n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5576 A single dimension of the return matrix may be left unspecified and Octave\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5577 will determine its size automatically. An empty matrix ([]) is used to flag\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	5578 the unspecified dimension.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	5579 @seealso{resize, vec, postpad, cat, squeeze}\n\
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5580 @end deftypefn")
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5581 {
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5582 octave_value retval;
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5583
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5584 int nargin = args.length ();
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5585
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5586 dim_vector new_dims;
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5587
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5588 if (nargin == 2)
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5589 {
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5590 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	5591
20267 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20253 diff changeset	5592 if (new_size.numel () < 2)
17915 56d2b6838405 Issue an error if reshape called with just a single dimension. Rik <rik@octave.org> parents: 17843 diff changeset	5593 {
56d2b6838405 Issue an error if reshape called with just a single dimension. Rik <rik@octave.org> parents: 17843 diff changeset	5594 error ("reshape: SIZE must have 2 or more dimensions");
56d2b6838405 Issue an error if reshape called with just a single dimension. Rik <rik@octave.org> parents: 17843 diff changeset	5595 return retval;
56d2b6838405 Issue an error if reshape called with just a single dimension. Rik <rik@octave.org> parents: 17843 diff changeset	5596 }
56d2b6838405 Issue an error if reshape called with just a single dimension. Rik <rik@octave.org> parents: 17843 diff changeset	5597
20267 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20253 diff changeset	5598 new_dims = dim_vector::alloc (new_size.numel ());
a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20253 diff changeset	5599
a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20253 diff changeset	5600 for (octave_idx_type i = 0; i < new_size.numel (); i++)
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5601 {
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5602 if (new_size(i) < 0)
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5603 {
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	5604 error ("reshape: SIZE must be non-negative");
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5605 break;
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5606 }
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5607 else
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5608 new_dims(i) = new_size(i);
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5609 }
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5610 }
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5611 else if (nargin > 2)
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5612 {
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5613 new_dims = dim_vector::alloc (nargin-1);
5013 1eb9ce5c0152 [project @ 2004-09-21 22:18:07 by jwe] jwe parents: 4986 diff changeset	5614 int empty_dim = -1;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	5615
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5616 for (int i = 1; i < nargin; i++)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5617 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5618 if (args(i).is_empty ())
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5619 {
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5620 if (empty_dim > 0)
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5621 {
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5622 error ("reshape: only a single dimension can be unknown");
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5623 break;
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5624 }
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5625 else
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5626 {
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5627 empty_dim = i;
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5628 new_dims(i-1) = 1;
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5629 }
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5630 }
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5631 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5632 {
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5633 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	5634
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5635 if (error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5636 break;
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5637 else if (new_dims(i-1) < 0)
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5638 {
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	5639 error ("reshape: SIZE must be non-negative");
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5640 break;
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5641 }
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5642 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5643 }
5013 1eb9ce5c0152 [project @ 2004-09-21 22:18:07 by jwe] jwe parents: 4986 diff changeset	5644
1eb9ce5c0152 [project @ 2004-09-21 22:18:07 by jwe] jwe parents: 4986 diff changeset	5645 if (! error_state && (empty_dim > 0))
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5646 {
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5647 octave_idx_type nel = new_dims.numel ();
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5648
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5649 if (nel == 0)
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5650 new_dims(empty_dim-1) = 0;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5651 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5652 {
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5653 octave_idx_type a_nel = args(0).numel ();
d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5654 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	5655
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5656 if (a_nel != size_empty_dim * nel)
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	5657 error ("reshape: SIZE is not divisible by the product of known dimensions (= %d)",
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	5658 nel);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5659 else
10693 d95a6e491a6c improve reshape Jaroslav Hajek <highegg@gmail.com> parents: 10687 diff changeset	5660 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	5661 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5662 }
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5663 }
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5664 else
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5665 {
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5798 diff changeset	5666 print_usage ();
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5667 return retval;
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5668 }
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5669
10352 a3635bc1ea19 remove Array2 Jaroslav Hajek <highegg@gmail.com> parents: 10350 diff changeset	5670 if (! error_state)
a3635bc1ea19 remove Array2 Jaroslav Hajek <highegg@gmail.com> parents: 10350 diff changeset	5671 retval = args(0).reshape (new_dims);
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5672
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5673 return retval;
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5674 }
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	5675
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5676 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5677 %!assert (size (reshape (ones (4, 4), 2, 8)), [2, 8])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5678 %!assert (size (reshape (ones (4, 4), 8, 2)), [8, 2])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5679 %!assert (size (reshape (ones (15, 4), 1, 60)), [1, 60])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5680 %!assert (size (reshape (ones (15, 4), 60, 1)), [60, 1])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5681
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5682 %!assert (size (reshape (ones (4, 4, "single"), 2, 8)), [2, 8])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5683 %!assert (size (reshape (ones (4, 4, "single"), 8, 2)), [8, 2])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5684 %!assert (size (reshape (ones (15, 4, "single"), 1, 60)), [1, 60])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5685 %!assert (size (reshape (ones (15, 4, "single"), 60, 1)), [60, 1])
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5686
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5687 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5688 %! s.a = 1;
17915 56d2b6838405 Issue an error if reshape called with just a single dimension. Rik <rik@octave.org> parents: 17843 diff changeset	5689 %! fail ("reshape (s, 2, 3)", "can't reshape 1x1 array to 2x3 array");
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5690
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5691 %!error reshape ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5692 %!error reshape (1, 2, 3, 4)
17915 56d2b6838405 Issue an error if reshape called with just a single dimension. Rik <rik@octave.org> parents: 17843 diff changeset	5693 %!error <SIZE must have 2 or more dimensions> reshape (1:3, 3)
56d2b6838405 Issue an error if reshape called with just a single dimension. Rik <rik@octave.org> parents: 17843 diff changeset	5694 %!error <SIZE must be non-negative> reshape (1:3, [3 -1])
56d2b6838405 Issue an error if reshape called with just a single dimension. Rik <rik@octave.org> parents: 17843 diff changeset	5695 %!error <only a single dimension can be unknown> reshape (1:3, 1,[],[],3)
56d2b6838405 Issue an error if reshape called with just a single dimension. Rik <rik@octave.org> parents: 17843 diff changeset	5696 %!error <SIZE must be non-negative> reshape (1:3, 3, -1)
56d2b6838405 Issue an error if reshape called with just a single dimension. Rik <rik@octave.org> parents: 17843 diff changeset	5697 %!error <SIZE is not divisible> reshape (1:3, 3, [], 2)
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5698 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5699
10694 d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	5700 DEFUN (vec, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	5701 "-- texinfo --\n\
12578 f5a780d675a1 Clean up operator and function indices in documentation. Rik <octave@nomad.inbox5.com> parents: 12575 diff changeset	5702 @deftypefn {Built-in Function} {@var{v} =} vec (@var{x})\n\
f5a780d675a1 Clean up operator and function indices in documentation. Rik <octave@nomad.inbox5.com> parents: 12575 diff changeset	5703 @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	5704 Return the vector obtained by stacking the columns of the matrix @var{x}\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5705 one above the other.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5706 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5707 Without @var{dim} this is equivalent to @code{@var{x}(:)}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5708 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5709 If @var{dim} is supplied, the dimensions of @var{v} are set to @var{dim}\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5710 with all elements along the last dimension. This is equivalent to\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5711 @code{shiftdim (@var{x}(:), 1-@var{dim})}.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	5712 @seealso{vech, resize, cat}\n\
10694 d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	5713 @end deftypefn")
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	5714 {
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	5715 octave_value retval;
11402 a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5716 int dim = 1;
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5717
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5718 int nargin = args.length ();
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5719
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5720 if (nargin < 1 \|\| nargin > 2)
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5721 print_usage () ;
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5722
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5723 if (! error_state && nargin == 2)
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5724 {
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5725 dim = args(1).idx_type_value ();
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5726
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5727 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	5728 error ("vec: DIM must be greater than zero");
11402 a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5729 }
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5730
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5731 if (! error_state)
10694 d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	5732 {
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	5733 octave_value colon (octave_value::magic_colon_t);
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	5734 octave_value arg = args(0);
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	5735 retval = arg.single_subsref ("(", colon);
11402 a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5736
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5737
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5738 if (! error_state && dim > 1)
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5739 {
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5740 dim_vector new_dims = dim_vector::alloc (dim);
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5741
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5742 for (int i = 0; i < dim-1; i++)
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5743 new_dims(i) = 1;
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5744
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5745 new_dims(dim-1) = retval.numel ();
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5746
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5747 retval = retval.reshape (new_dims);
a9a3ee461b83 Add second argument to Fvec Judd Storrs <jstorrs@gmail.com> parents: 11357 diff changeset	5748 }
10694 d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	5749 }
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	5750
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	5751 return retval;
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	5752 }
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	5753
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	5754 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5755 %!assert (vec ([1, 2; 3, 4]), [1; 3; 2; 4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5756 %!assert (vec ([1, 3, 2, 4]), [1; 3; 2; 4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5757 %!assert (vec ([1, 2, 3, 4], 2), [1, 2, 3, 4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5758 %!assert (vec ([1, 2; 3, 4]), vec ([1, 2; 3, 4], 1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5759 %!assert (vec ([1, 2; 3, 4], 1), [1; 3; 2; 4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5760 %!assert (vec ([1, 2; 3, 4], 2), [1, 3, 2, 4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5761 %!assert (vec ([1, 3; 2, 4], 3), reshape ([1, 2, 3, 4], 1, 1, 4))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5762 %!assert (vec ([1, 3; 2, 4], 3), shiftdim (vec ([1, 3; 2, 4]), -2))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5763
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5764 %!error vec ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5765 %!error vec (1, 2, 3)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5766 %!error vec ([1, 2; 3, 4], 0)
10694 d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	5767 */
d97165928d05 implement built-in vec() Jaroslav Hajek <highegg@gmail.com> parents: 10693 diff changeset	5768
4532 01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	5769 DEFUN (squeeze, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	5770 "-- texinfo --\n\
4532 01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	5771 @deftypefn {Built-in Function} {} squeeze (@var{x})\n\
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	5772 Remove singleton dimensions from @var{x} and return the result.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5773 \n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	5774 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	5775 a minimum of two dimensions and row vectors are left unchanged.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	5776 @seealso{reshape}\n\
4532 01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	5777 @end deftypefn")
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	5778 {
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	5779 octave_value retval;
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	5780
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	5781 if (args.length () == 1)
4545 c16f153836a0 [project @ 2003-10-24 04:45:45 by jwe] jwe parents: 4532 diff changeset	5782 retval = args(0).squeeze ();
4532 01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	5783 else
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	5784 print_usage ();
4532 01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	5785
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	5786 return retval;
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	5787 }
01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4516 diff changeset	5788
8458 d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	5789 DEFUN (full, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	5790 "-- texinfo --\n\
15038 ab18578c2ade doc: Update docstrings for built-in functions to not use "Loadable Function" as type. Rik <rik@octave.org> parents: 15034 diff changeset	5791 @deftypefn {Built-in Function} {@var{FM} =} full (@var{SM})\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5792 Return a full storage matrix from a sparse, diagonal, or permutation matrix,\n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	5793 or a range.\n\
18848 53af80da6781 doc: Update documentation of sparse functions including seealso links. Rik <rik@octave.org> parents: 18823 diff changeset	5794 @seealso{sparse, issparse}\n\
8458 d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	5795 @end deftypefn")
d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	5796 {
d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	5797 octave_value retval;
d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	5798
d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	5799 if (args.length () == 1)
d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	5800 retval = args(0).full_value ();
d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	5801 else
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	5802 print_usage ();
8458 d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	5803
d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	5804 return retval;
d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	5805 }
d254a21e0120 reimplement full as method of octave_base_value Jaroslav Hajek <highegg@gmail.com> parents: 8433 diff changeset	5806
6945 6bbf56a9718a [project @ 2007-10-02 20:47:22 by jwe] jwe parents: 6887 diff changeset	5807 // Compute various norms of the vector X.
6bbf56a9718a [project @ 2007-10-02 20:47:22 by jwe] jwe parents: 6887 diff changeset	5808
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	5809 DEFUN (norm, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	5810 "-- texinfo --\n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 12578 diff changeset	5811 @deftypefn {Built-in Function} {} norm (@var{A})\n\
7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 12578 diff changeset	5812 @deftypefnx {Built-in Function} {} norm (@var{A}, @var{p})\n\
7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 12578 diff changeset	5813 @deftypefnx {Built-in Function} {} norm (@var{A}, @var{p}, @var{opt})\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5814 Compute the p-norm of the matrix @var{A}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5815 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	5816 If the second argument is missing, @code{p = 2} is assumed.\n\
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	5817 \n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 12578 diff changeset	5818 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	5819 \n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	5820 @table @asis\n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	5821 @item @var{p} = @code{1}\n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 12578 diff changeset	5822 1-norm, the largest column sum of the absolute values of @var{A}.\n\
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	5823 \n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	5824 @item @var{p} = @code{2}\n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 12578 diff changeset	5825 Largest singular value of @var{A}.\n\
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	5826 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	5827 @item @var{p} = @code{Inf} or @qcode{\"inf\"}\n\
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	5828 @cindex infinity norm\n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 12578 diff changeset	5829 Infinity norm, the largest row sum of the absolute values of @var{A}.\n\
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	5830 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	5831 @item @var{p} = @qcode{\"fro\"}\n\
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	5832 @cindex Frobenius norm\n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 12578 diff changeset	5833 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	5834 \n\
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5835 @item other @var{p}, @code{@var{p} > 1}\n\
12642 f96b9b9f141b doc: Periodic grammarcheck and spellcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	5836 @cindex general p-norm\n\
8303 b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5837 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	5838 @end table\n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	5839 \n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 12578 diff changeset	5840 If @var{A} is a vector or a scalar:\n\
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	5841 \n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	5842 @table @asis\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	5843 @item @var{p} = @code{Inf} or @qcode{\"inf\"}\n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 12578 diff changeset	5844 @code{max (abs (@var{A}))}.\n\
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	5845 \n\
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	5846 @item @var{p} = @code{-Inf}\n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 12578 diff changeset	5847 @code{min (abs (@var{A}))}.\n\
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	5848 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	5849 @item @var{p} = @qcode{\"fro\"}\n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 12578 diff changeset	5850 Frobenius norm of @var{A}, @code{sqrt (sumsq (abs (A)))}.\n\
7189 e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7145 diff changeset	5851 \n\
8303 b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5852 @item @var{p} = 0\n\
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5853 Hamming norm - the number of nonzero elements.\n\
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5854 \n\
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5855 @item other @var{p}, @code{@var{p} > 1}\n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 12578 diff changeset	5856 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	5857 \n\
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5858 @item other @var{p} @code{@var{p} < 1}\n\
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5859 the p-pseudonorm defined as above.\n\
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	5860 @end table\n\
8303 b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5861 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	5862 If @var{opt} is the value @qcode{\"rows\"}, treat each row as a vector and\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10682 diff changeset	5863 compute its norm. The result is returned as a column vector.\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	5864 Similarly, if @var{opt} is @qcode{\"columns\"} or @qcode{\"cols\"} then\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	5865 compute 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	5866 @seealso{cond, svd}\n\
6508 184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	5867 @end deftypefn")
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	5868 {
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	5869 octave_value_list retval;
6508 184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	5870
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	5871 int nargin = args.length ();
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	5872
8303 b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5873 if (nargin >= 1 && nargin <= 3)
6508 184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	5874 {
6953 4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	5875 octave_value x_arg = args(0);
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe] jwe parents: 6945 diff changeset	5876
10185 455759a5fcbe fix norm and svd on empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 10182 diff changeset	5877 if (x_arg.ndims () == 2)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5878 {
8303 b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5879 enum { sfmatrix, sfcols, sfrows, sffrob, sfinf } strflag = sfmatrix;
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5880 if (nargin > 1 && args(nargin-1).is_string ())
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5881 {
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5882 std::string str = args(nargin-1).string_value ();
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5883 if (str == "cols" \|\| str == "columns")
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5884 strflag = sfcols;
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5885 else if (str == "rows")
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5886 strflag = sfrows;
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5887 else if (str == "fro")
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5888 strflag = sffrob;
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5889 else if (str == "inf")
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5890 strflag = sfinf;
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5891 else
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5892 error ("norm: unrecognized option: %s", str.c_str ());
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5893 // 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	5894 nargin --;
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5895 }
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5896
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5897 if (! error_state)
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5898 {
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5899 octave_value p_arg = (nargin > 1) ? args(1) : octave_value (2);
17115 00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5900
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5901 if (p_arg.is_empty ())
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5902 p_arg = octave_value (2);
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5903 else if (p_arg.is_string ())
8303 b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5904 {
17115 00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5905 std::string str = p_arg.string_value ();
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5906 if ((strflag == sfcols \|\| strflag == sfrows))
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5907 {
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5908 if (str == "cols" \|\| str == "columns" \|\| str == "rows")
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5909 error ("norm: invalid combination of options");
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5910 else if (str == "fro")
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5911 p_arg = octave_value (2);
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5912 else if (str == "inf")
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5913 p_arg = octave_Inf;
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5914 else
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5915 error ("norm: unrecognized option: %s", str.c_str ());
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5916 }
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5917 else
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5918 error ("norm: invalid combination of options");
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5919 }
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5920 else if (! p_arg.is_scalar_type ())
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5921 gripe_wrong_type_arg ("norm", p_arg, true);
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5922
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5923 if (! error_state)
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5924 {
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5925 switch (strflag)
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5926 {
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5927 case sfmatrix:
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5928 retval(0) = xnorm (x_arg, p_arg);
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5929 break;
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5930 case sfcols:
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5931 retval(0) = xcolnorms (x_arg, p_arg);
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5932 break;
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5933 case sfrows:
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5934 retval(0) = xrownorms (x_arg, p_arg);
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5935 break;
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5936 case sffrob:
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5937 retval(0) = xfrobnorm (x_arg);
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5938 break;
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5939 case sfinf:
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5940 retval(0) = xnorm (x_arg, octave_Inf);
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5941 break;
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	5942 }
8303 b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5943 }
b11c31849b44 improve norm computation capabilities Jaroslav Hajek <highegg@gmail.com> parents: 8286 diff changeset	5944 }
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5945 }
6508 184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	5946 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	5947 error ("norm: only valid for 2-D objects");
6508 184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	5948 }
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	5949 else
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	5950 print_usage ();
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	5951
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	5952 return retval;
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	5953 }
184ab67c3bc1 [project @ 2007-04-07 00:43:09 by jwe] jwe parents: 6401 diff changeset	5954
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5955 /*
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5956 %!shared x
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5957 %! x = [1, -3, 4, 5, -7];
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5958 %!assert (norm (x,1), 20)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5959 %!assert (norm (x,2), 10)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5960 %!assert (norm (x,3), 8.24257059961711, -4*eps)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5961 %!assert (norm (x,Inf), 7)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5962 %!assert (norm (x,-Inf), 1)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5963 %!assert (norm (x,"inf"), 7)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5964 %!assert (norm (x,"fro"), 10, -eps)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5965 %!assert (norm (x), 10)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5966 %!assert (norm ([1e200, 1]), 1e200)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5967 %!assert (norm ([3+4i, 3-4i, sqrt(31)]), 9, -4*eps)
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5968 %!shared m
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5969 %! m = magic (4);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5970 %!assert (norm (m,1), 34)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5971 %!assert (norm (m,2), 34, -eps)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5972 %!assert (norm (m,Inf), 34)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5973 %!assert (norm (m,"inf"), 34)
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5974 %!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	5975 %! 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	5976 %! 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	5977 %! fhi = 1e+300;
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5978 %!assert (norm (flom2,"fro"), sqrt (30)flo, -eps)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5979 %!assert (norm (fhim2,"fro"), sqrt (30)fhi, -eps)
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5980
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5981 %!shared x
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5982 %! x = single ([1, -3, 4, 5, -7]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5983 %!assert (norm (x,1), single (20))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5984 %!assert (norm (x,2), single (10))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5985 %!assert (norm (x,3), single (8.24257059961711), -4*eps ("single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5986 %!assert (norm (x,Inf), single (7))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5987 %!assert (norm (x,-Inf), single (1))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5988 %!assert (norm (x,"inf"), single (7))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5989 %!assert (norm (x,"fro"), single (10), -eps ("single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5990 %!assert (norm (x), single (10))
18710 5bd1ca29c5f0 Clean up questionable code bits identified by clang sanitize. Rik <rik@octave.org> parents: 18211 diff changeset	5991 %!assert (norm (single ([1e38, 1])), single (1e38))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5992 %!assert (norm (single ([3+4i, 3-4i, sqrt(31)])), single (9), -4*eps ("single"))
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5993 %!shared m
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5994 %! m = single (magic (4));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5995 %!assert (norm (m,1), single (34))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5996 %!assert (norm (m,2), single (34), -eps ("single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5997 %!assert (norm (m,Inf), single (34))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	5998 %!assert (norm (m,"inf"), single (34))
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	5999 %!shared m2, flo, fhi
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6000 %! m2 = single ([1,2;3,4]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6001 %! flo = single (1e-300);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6002 %! fhi = single (1e+300);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6003 %!assert (norm (flom2,"fro"), single (sqrt (30)flo), -eps ("single"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6004 %!assert (norm (fhim2,"fro"), single (sqrt (30)fhi), -eps ("single"))
14520 c4ed0fdf2b62 Fix initialization in Higham's method for norm estimate (bug #36031). Marco Caliari <marco.caliari@univr.it> parents: 14491 diff changeset	6005
17115 00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	6006 %!shared q
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	6007 %! q = rand (1e3, 3);
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	6008 %!assert (norm (q, 3, "rows"), sum (q.^3, 2).^(1/3), sqrt (eps));
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	6009 %!assert (norm (q, "fro", "rows"), sum (q.^2, 2).^(1/2), sqrt (eps));
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	6010 %!assert (norm (q, "fro", "rows"), sqrt (sumsq (q, 2)), sqrt (eps));
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	6011 %!assert (norm (q, "fro", "cols"), sqrt (sumsq (q, 1)), sqrt (eps));
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	6012 %!assert (norm (q, 3, "cols"), sum (q.^3, 1).^(1/3), sqrt (eps));
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	6013 %!assert (norm (q, "inf", "rows"), norm (q, Inf, "rows"));
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	6014 %!assert (norm (q, "inf", "cols"), norm (q, Inf, "cols"));
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	6015 %!assert (norm (q, [], "rows"), norm (q, 2, "rows"));
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	6016 %!assert (norm (q, [], "cols"), norm (q, 2, "cols"));
00985134145e norm: fix argument handling to match the docstring (bug #34778) Mike Miller <mtmiller@ieee.org> parents: 16892 diff changeset	6017
14520 c4ed0fdf2b62 Fix initialization in Higham's method for norm estimate (bug #36031). Marco Caliari <marco.caliari@univr.it> parents: 14491 diff changeset	6018 %!test
c4ed0fdf2b62 Fix initialization in Higham's method for norm estimate (bug #36031). Marco Caliari <marco.caliari@univr.it> parents: 14491 diff changeset	6019 %! ## Test for norm returning NaN on sparse matrix (bug #30631)
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6020 %! A = sparse (2,2);
14520 c4ed0fdf2b62 Fix initialization in Higham's method for norm estimate (bug #36031). Marco Caliari <marco.caliari@univr.it> parents: 14491 diff changeset	6021 %! A(2,1) = 1;
c4ed0fdf2b62 Fix initialization in Higham's method for norm estimate (bug #36031). Marco Caliari <marco.caliari@univr.it> parents: 14491 diff changeset	6022 %! assert (norm (A), 1);
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6023 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6024
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6025 static octave_value
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6026 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	6027 const octave_value_list& args)
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6028 {
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6029 octave_value retval;
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6030 if (args.length () == 1)
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6031 retval = do_unary_op (op, args(0));
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6032 else
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6033 print_usage ();
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6034
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6035 return retval;
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6036 }
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6037
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6038 DEFUN (not, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6039 "-- texinfo --\n\
19222 c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 19186 diff changeset	6040 @deftypefn {Built-in Function} {@var{z} =} not (@var{x})\n\
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 19186 diff changeset	6041 Return the logical NOT of @var{x}.\n\
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 19186 diff changeset	6042 \n\
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 19186 diff changeset	6043 This function is equivalent to the operator syntax @w{@code{! x}}.\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	6044 @seealso{and, or, xor}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6045 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6046 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6047 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	6048 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6049
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6050 DEFUN (uplus, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6051 "-- texinfo --\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6052 @deftypefn {Built-in Function} {} uplus (@var{x})\n\
17268 1c21f264d26f doc: Rename @xcode macro to @tcode (transpose code) for clarity. Rik <rik@octave.org> parents: 17206 diff changeset	6053 This function and @w{@tcode{+ x}} are equivalent.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	6054 @seealso{uminus, plus, minus}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6055 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6056 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6057 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	6058 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6059
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6060 DEFUN (uminus, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6061 "-- texinfo --\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6062 @deftypefn {Built-in Function} {} uminus (@var{x})\n\
17268 1c21f264d26f doc: Rename @xcode macro to @tcode (transpose code) for clarity. Rik <rik@octave.org> parents: 17206 diff changeset	6063 This function and @w{@tcode{- x}} are equivalent.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	6064 @seealso{uplus, minus}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6065 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6066 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6067 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	6068 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6069
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6070 DEFUN (transpose, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6071 "-- texinfo --\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6072 @deftypefn {Built-in Function} {} transpose (@var{x})\n\
13780 990762e784fe Fix confusing interaction between @code macro and transpose operator (') in documentation (Bug #34661). Rik <octave@nomad.inbox5.com> parents: 13760 diff changeset	6073 Return the transpose of @var{x}.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6074 \n\
17268 1c21f264d26f doc: Rename @xcode macro to @tcode (transpose code) for clarity. Rik <rik@octave.org> parents: 17206 diff changeset	6075 This function and @tcode{x.'} are equivalent.\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	6076 @seealso{ctranspose}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6077 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6078 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6079 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	6080 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6081
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6082 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6083 %!assert (2.', 2)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6084 %!assert (2i.', 2i)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6085 %!assert ([1:4].', [1;2;3;4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6086 %!assert ([1;2;3;4].', [1:4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6087 %!assert ([1,2;3,4].', [1,3;2,4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6088 %!assert ([1,2i;3,4].', [1,3;2i,4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6089
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6090 %!assert (transpose ([1,2;3,4]), [1,3;2,4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6091
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6092 %!assert (single (2).', single (2))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6093 %!assert (single (2i).', single (2i))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6094 %!assert (single ([1:4]).', single ([1;2;3;4]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6095 %!assert (single ([1;2;3;4]).', single ([1:4]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6096 %!assert (single ([1,2;3,4]).', single ([1,3;2,4]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6097 %!assert (single ([1,2i;3,4]).', single ([1,3;2i,4]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6098
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6099 %!assert (transpose (single ([1,2;3,4])), single ([1,3;2,4]))
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6100 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6101
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6102 DEFUN (ctranspose, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6103 "-- texinfo --\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6104 @deftypefn {Built-in Function} {} ctranspose (@var{x})\n\
13780 990762e784fe Fix confusing interaction between @code macro and transpose operator (') in documentation (Bug #34661). Rik <octave@nomad.inbox5.com> parents: 13760 diff changeset	6105 Return the complex conjugate transpose of @var{x}.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6106 \n\
17268 1c21f264d26f doc: Rename @xcode macro to @tcode (transpose code) for clarity. Rik <rik@octave.org> parents: 17206 diff changeset	6107 This function and @tcode{x'} are equivalent.\n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	6108 @seealso{transpose}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6109 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6110 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6111 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	6112 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6113
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6114 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6115 %!assert (2', 2)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6116 %!assert (2i', -2i)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6117 %!assert ([1:4]', [1;2;3;4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6118 %!assert ([1;2;3;4]', [1:4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6119 %!assert ([1,2;3,4]', [1,3;2,4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6120 %!assert ([1,2i;3,4]', [1,3;-2i,4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6121
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6122 %!assert (ctranspose ([1,2i;3,4]), [1,3;-2i,4])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6123
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6124 %!assert (single (2)', single (2))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6125 %!assert (single (2i)', single (-2i))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6126 %!assert (single ([1:4])', single ([1;2;3;4]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6127 %!assert (single ([1;2;3;4])', single ([1:4]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6128 %!assert (single ([1,2;3,4])', single ([1,3;2,4]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6129 %!assert (single ([1,2i;3,4])', single ([1,3;-2i,4]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6130
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6131 %!assert (ctranspose (single ([1,2i;3,4])), single ([1,3;-2i,4]))
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6132 */
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6133
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6134 static octave_value
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6135 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	6136 const octave_value_list& args)
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6137 {
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6138 octave_value retval;
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6139
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6140 if (args.length () == 2)
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6141 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	6142 else
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6143 print_usage ();
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6144
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6145 return retval;
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6146 }
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6147
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6148 static octave_value
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6149 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	6150 octave_value::assign_op aop,
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6151 const octave_value_list& args)
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6152 {
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6153 octave_value retval;
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6154 int nargin = args.length ();
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6155
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6156 switch (nargin)
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6157 {
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6158 case 0:
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6159 print_usage ();
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6160 break;
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6161 case 1:
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6162 retval = args(0);
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6163 break;
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6164 case 2:
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6165 retval = do_binary_op (op, args(0), args(1));
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6166 break;
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6167 default:
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6168 retval = do_binary_op (op, args(0), args(1));
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6169 for (int i = 2; i < nargin; i++)
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6170 retval.assign (aop, args(i));
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6171 break;
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6172 }
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6173
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6174 return retval;
76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6175 }
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	6176
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6177 DEFUN (plus, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6178 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	6179 @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	6180 @deftypefnx {Built-in Function} {} plus (@var{x1}, @var{x2}, @dots{})\n\
17268 1c21f264d26f doc: Rename @xcode macro to @tcode (transpose code) for clarity. Rik <rik@octave.org> parents: 17206 diff changeset	6181 This function and @w{@tcode{x + y}} are equivalent.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6182 \n\
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	6183 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	6184 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	6185 \n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	6186 @example\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	6187 (@dots{}((x1 + x2) + x3) + @dots{})\n\
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	6188 @end example\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	6189 \n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	6190 At least one argument is required.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	6191 @seealso{minus, uplus}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6192 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6193 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6194 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	6195 octave_value::op_add_eq, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6196 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6197
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6198 DEFUN (minus, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6199 "-- texinfo --\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6200 @deftypefn {Built-in Function} {} minus (@var{x}, @var{y})\n\
17268 1c21f264d26f doc: Rename @xcode macro to @tcode (transpose code) for clarity. Rik <rik@octave.org> parents: 17206 diff changeset	6201 This function and @w{@tcode{x - y}} are equivalent.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	6202 @seealso{plus, uminus}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6203 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6204 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6205 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	6206 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6207
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6208 DEFUN (mtimes, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6209 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	6210 @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	6211 @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	6212 Return the matrix multiplication product of inputs.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6213 \n\
17268 1c21f264d26f doc: Rename @xcode macro to @tcode (transpose code) for clarity. Rik <rik@octave.org> parents: 17206 diff changeset	6214 This function and @w{@tcode{x * y}} are equivalent.\n\
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	6215 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	6216 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	6217 \n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	6218 @example\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	6219 (@dots{}((x1 * x2) * x3) * @dots{})\n\
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	6220 @end example\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	6221 \n\
11575 d6619410e79c Spellcheck documentation before 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11572 diff changeset	6222 At least one argument is required.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	6223 @seealso{times, plus, minus, rdivide, mrdivide, mldivide, mpower}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6224 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6225 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6226 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	6227 octave_value::op_mul_eq, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6228 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6229
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6230 DEFUN (mrdivide, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6231 "-- texinfo --\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6232 @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	6233 Return the matrix right division of @var{x} and @var{y}.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6234 \n\
17268 1c21f264d26f doc: Rename @xcode macro to @tcode (transpose code) for clarity. Rik <rik@octave.org> parents: 17206 diff changeset	6235 This function and @w{@tcode{x / y}} are equivalent.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	6236 @seealso{mldivide, rdivide, plus, minus}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6237 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6238 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6239 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	6240 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6241
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6242 DEFUN (mpower, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6243 "-- texinfo --\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6244 @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	6245 Return the matrix power operation of @var{x} raised to the @var{y} power.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6246 \n\
17268 1c21f264d26f doc: Rename @xcode macro to @tcode (transpose code) for clarity. Rik <rik@octave.org> parents: 17206 diff changeset	6247 This function and @w{@tcode{x ^ y}} are equivalent.\n\
15034 1116864ee270 doc: Fix for bad cross-referencing due to use of aliases in Texinfo. Rik <rik@octave.org> parents: 15031 diff changeset	6248 @seealso{power, mtimes, plus, minus}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6249 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6250 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6251 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	6252 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6253
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6254 DEFUN (mldivide, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6255 "-- texinfo --\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6256 @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	6257 Return the matrix left division of @var{x} and @var{y}.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6258 \n\
17268 1c21f264d26f doc: Rename @xcode macro to @tcode (transpose code) for clarity. Rik <rik@octave.org> parents: 17206 diff changeset	6259 This function and @w{@tcode{x @xbackslashchar{} y}} are equivalent.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	6260 @seealso{mrdivide, ldivide, rdivide}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6261 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6262 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6263 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	6264 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6265
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6266 DEFUN (lt, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6267 "-- texinfo --\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6268 @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	6269 This function is equivalent to @w{@code{x < y}}.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	6270 @seealso{le, eq, ge, gt, ne}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6271 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6272 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6273 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	6274 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6275
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6276 DEFUN (le, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6277 "-- texinfo --\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6278 @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	6279 This function is equivalent to @w{@code{x <= y}}.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	6280 @seealso{eq, ge, gt, ne, lt}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6281 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6282 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6283 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	6284 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6285
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6286 DEFUN (eq, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6287 "-- texinfo --\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6288 @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	6289 Return true if the two inputs are equal.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6290 \n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	6291 This function is equivalent to @w{@code{x == y}}.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	6292 @seealso{ne, isequal, le, ge, gt, ne, lt}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6293 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6294 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6295 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	6296 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6297
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6298 DEFUN (ge, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6299 "-- texinfo --\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6300 @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	6301 This function is equivalent to @w{@code{x >= y}}.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	6302 @seealso{le, eq, gt, ne, lt}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6303 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6304 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6305 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	6306 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6307
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6308 DEFUN (gt, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6309 "-- texinfo --\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6310 @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	6311 This function is equivalent to @w{@code{x > y}}.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	6312 @seealso{le, eq, ge, ne, lt}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6313 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6314 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6315 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	6316 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6317
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6318 DEFUN (ne, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6319 "-- texinfo --\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6320 @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	6321 Return true if the two inputs are not equal.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6322 \n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	6323 This function is equivalent to @w{@code{x != y}}.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	6324 @seealso{eq, isequal, le, ge, lt}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6325 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6326 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6327 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	6328 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6329
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6330 DEFUN (times, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6331 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	6332 @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	6333 @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	6334 Return the element-by-element multiplication product of inputs.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6335 \n\
17268 1c21f264d26f doc: Rename @xcode macro to @tcode (transpose code) for clarity. Rik <rik@octave.org> parents: 17206 diff changeset	6336 This function and @w{@tcode{x .* y}} are equivalent.\n\
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	6337 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	6338 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	6339 \n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	6340 @example\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	6341 (@dots{}((x1 .* x2) .* x3) .* @dots{})\n\
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	6342 @end example\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	6343 \n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	6344 At least one argument is required.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	6345 @seealso{mtimes, rdivide}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6346 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6347 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6348 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	6349 octave_value::op_el_mul_eq, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6350 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6351
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6352 DEFUN (rdivide, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6353 "-- texinfo --\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6354 @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	6355 Return the element-by-element right division of @var{x} and @var{y}.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6356 \n\
17268 1c21f264d26f doc: Rename @xcode macro to @tcode (transpose code) for clarity. Rik <rik@octave.org> parents: 17206 diff changeset	6357 This function and @w{@tcode{x ./ y}} are equivalent.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	6358 @seealso{ldivide, mrdivide, times, plus}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6359 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6360 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6361 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	6362 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6363
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6364 DEFUN (power, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6365 "-- texinfo --\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6366 @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	6367 Return the element-by-element operation of @var{x} raised to the\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6368 @var{y} power.\n\
14169 c0ca47ab7641 doc: Better explain which complex result is chosen by .^ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	6369 \n\
17268 1c21f264d26f doc: Rename @xcode macro to @tcode (transpose code) for clarity. Rik <rik@octave.org> parents: 17206 diff changeset	6370 This function and @w{@tcode{x .^ y}} are equivalent.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6371 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6372 If several complex results are possible, returns the one with smallest\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6373 non-negative argument (angle). Use @code{realpow}, @code{realsqrt},\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6374 @code{cbrt}, or @code{nthroot} if a real result is preferred.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6375 \n\
14169 c0ca47ab7641 doc: Better explain which complex result is chosen by .^ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	6376 @seealso{mpower, realpow, realsqrt, cbrt, nthroot}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6377 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6378 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6379 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	6380 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6381
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6382 DEFUN (ldivide, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6383 "-- texinfo --\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6384 @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	6385 Return the element-by-element left division of @var{x} and @var{y}.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6386 \n\
17268 1c21f264d26f doc: Rename @xcode macro to @tcode (transpose code) for clarity. Rik <rik@octave.org> parents: 17206 diff changeset	6387 This function and @w{@tcode{x .@xbackslashchar{} y}} are equivalent.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	6388 @seealso{rdivide, mldivide, times, plus}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6389 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6390 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6391 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	6392 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6393
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6394 DEFUN (and, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6395 "-- texinfo --\n\
19222 c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 19186 diff changeset	6396 @deftypefn {Built-in Function} {@var{z} =} and (@var{x}, @var{y})\n\
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 19186 diff changeset	6397 @deftypefnx {Built-in Function} {@var{z} =} 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	6398 Return the logical AND of @var{x} and @var{y}.\n\
19222 c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 19186 diff changeset	6399 \n\
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 19186 diff changeset	6400 This function is equivalent to the operator syntax @w{@code{x & y}}. If\n\
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 19186 diff changeset	6401 more than two arguments are given, the logical AND is applied cumulatively\n\
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 19186 diff changeset	6402 from left to right:\n\
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	6403 \n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	6404 @example\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	6405 (@dots{}((x1 & x2) & x3) & @dots{})\n\
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	6406 @end example\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	6407 \n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	6408 At least one argument is required.\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	6409 @seealso{or, not, xor}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6410 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6411 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6412 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	6413 octave_value::op_el_and_eq, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6414 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6415
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6416 DEFUN (or, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6417 "-- texinfo --\n\
19222 c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 19186 diff changeset	6418 @deftypefn {Built-in Function} {@var{z} =} or (@var{x}, @var{y})\n\
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 19186 diff changeset	6419 @deftypefnx {Built-in Function} {@var{z} =} 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	6420 Return the logical OR of @var{x} and @var{y}.\n\
19222 c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 19186 diff changeset	6421 \n\
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 19186 diff changeset	6422 This function is equivalent to the operator syntax @w{@code{x \| y}}. If\n\
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 19186 diff changeset	6423 more than two arguments are given, the logical OR is applied cumulatively\n\
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 19186 diff changeset	6424 from left to right:\n\
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	6425 \n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	6426 @example\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	6427 (@dots{}((x1 \| x2) \| x3) \| @dots{})\n\
9339 c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	6428 @end example\n\
c0b104835d0d allow multiple arguments in plus,times,mtimes,and,or Jaroslav Hajek <highegg@gmail.com> parents: 9329 diff changeset	6429 \n\
11422 3cae59b4c0f7 Improve docstrings for functions which emulate operators. Rik <octave@nomad.inbox5.com> parents: 11402 diff changeset	6430 At least one argument is required.\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	6431 @seealso{and, not, xor}\n\
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6432 @end deftypefn")
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6433 {
9555 76ecc571879e improve unop/binop implementation in data.cc Jaroslav Hajek <highegg@gmail.com> parents: 9517 diff changeset	6434 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	6435 octave_value::op_el_or_eq, args);
6518 952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6436 }
952c8b00525e [project @ 2007-04-11 20:50:22 by jwe] jwe parents: 6508 diff changeset	6437
19783 c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6438 DEFUN (colon, args, ,
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6439 "-- texinfo --\n\
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6440 @deftypefn {Built-in Function} {@var{r} =} colon (@var{base}, @var{limit})\n\
19829 ca7599ae464d doc: Grammarcheck documentation ahead of 4.0 release. Rik <rik@octave.org> parents: 19783 diff changeset	6441 @deftypefnx {Built-in Function} {@var{r} =} colon (@var{base}, @var{increment}, @var{limit})\n\
ca7599ae464d doc: Grammarcheck documentation ahead of 4.0 release. Rik <rik@octave.org> parents: 19783 diff changeset	6442 Return the result of the colon expression corresponding to @var{base},\n\
ca7599ae464d doc: Grammarcheck documentation ahead of 4.0 release. Rik <rik@octave.org> parents: 19783 diff changeset	6443 @var{limit}, and optionally, @var{increment}.\n\
19783 c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6444 \n\
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6445 This function is equivalent to the operator syntax @w{@code{base : limit}}\n\
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6446 or @w{@code{base : increment : limit}}.\n\
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6447 @end deftypefn")
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6448 {
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6449 octave_value retval;
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6450 int nargin = args.length ();
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6451
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6452 switch (nargin)
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6453 {
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6454 case 2:
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6455 retval = do_colon_op (args(0), args(1));
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6456 break;
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6457
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6458 case 3:
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6459 retval = do_colon_op (args(0), args(1), args (2));
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6460 break;
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6461
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6462 default:
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6463 print_usage ();
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6464 break;
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6465 }
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6466
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6467 return retval;
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6468 }
c913247c85a8 make colon function work (bug #44290) John W. Eaton <jwe@octave.org> parents: 19777 diff changeset	6469
7065 97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	6470 static double tic_toc_timestamp = -1.0;
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6471
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6472 DEFUN (tic, args, nargout,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6473 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	6474 @deftypefn {Built-in Function} {} tic ()\n\
14853 72b8b39e12be doc: Periodic grammarcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 14849 diff changeset	6475 @deftypefnx {Built-in Function} {@var{id} =} tic ()\n\
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6476 @deftypefnx {Built-in Function} {} toc ()\n\
14635 f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6477 @deftypefnx {Built-in Function} {} toc (@var{id})\n\
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6478 @deftypefnx {Built-in Function} {@var{val} =} toc (@dots{})\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6479 Set or check a wall-clock timer.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6480 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6481 Calling @code{tic} without an output argument sets the internal timer state.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6482 Subsequent calls to @code{toc} return the number of seconds since the timer\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6483 was set.\n\
14635 f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6484 For example,\n\
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6485 \n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6486 @example\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	6487 @group\n\
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6488 tic ();\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	6489 # many computations later@dots{}\n\
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6490 elapsed_time = toc ();\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	6491 @end group\n\
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6492 @end example\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6493 \n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6494 @noindent\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6495 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	6496 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	6497 \n\
14635 f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6498 If called with one output argument, @code{tic} returns a scalar\n\
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6499 of type @code{uint64} that may be later passed to @code{toc}.\n\
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6500 \n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6501 @example\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6502 @group\n\
14635 f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6503 id = tic; sleep (5); toc (id)\n\
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6504 @result{} 5.0010\n\
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6505 @end group\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6506 @end example\n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6507 \n\
14635 f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6508 Calling @code{tic} and @code{toc} this way allows nested timing calls.\n\
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6509 \n\
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6510 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	6511 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	6512 @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	6513 between the calls. This may include time spent processing other jobs or\n\
14635 f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6514 doing nothing at all.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	6515 @seealso{toc, cputime}\n\
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6516 @end deftypefn")
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6517 {
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6518 octave_value retval;
7065 97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	6519
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6520 int nargin = args.length ();
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6521
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6522 if (nargin != 0)
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6523 warning ("tic: ignoring extra arguments");
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6524
7065 97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	6525 octave_time now;
97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	6526
97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	6527 double tmp = now.double_value ();
97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	6528
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6529 if (nargout > 0)
14635 f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6530 {
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6531 double ip = 0.0;
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6532 double frac = modf (tmp, &ip);
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6533 uint64_t microsecs = static_cast<uint64_t> (CLOCKS_PER_SEC * frac);
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6534 microsecs += CLOCKS_PER_SEC * static_cast<uint64_t> (ip);
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6535 retval = octave_uint64 (microsecs);
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6536 }
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6537 else
7065 97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	6538 tic_toc_timestamp = tmp;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	6539
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6540 return retval;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6541 }
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6542
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6543 DEFUN (toc, args, nargout,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6544 "-- texinfo --\n\
14853 72b8b39e12be doc: Periodic grammarcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 14849 diff changeset	6545 @deftypefn {Built-in Function} {} toc ()\n\
14635 f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6546 @deftypefnx {Built-in Function} {} toc (@var{id})\n\
14853 72b8b39e12be doc: Periodic grammarcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 14849 diff changeset	6547 @deftypefnx {Built-in Function} {@var{val} =} toc (@dots{})\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	6548 @seealso{tic, cputime}\n\
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6549 @end deftypefn")
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6550 {
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6551 octave_value retval;
7065 97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	6552
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6553 int nargin = args.length ();
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6554
14635 f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6555 double start_time = tic_toc_timestamp;
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6556
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6557 if (nargin > 1)
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6558 print_usage ();
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6559 else
7065 97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	6560 {
14635 f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6561 if (nargin == 1)
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6562 {
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6563 octave_uint64 id = args(0).uint64_scalar_value ();
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6564
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6565 if (! error_state)
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6566 {
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6567 uint64_t val = id.value ();
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6568
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6569 start_time
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6570 = (static_cast<double> (val / CLOCKS_PER_SEC)
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6571 + static_cast<double> (val % CLOCKS_PER_SEC)
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6572 / CLOCKS_PER_SEC);
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6573
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6574 // FIXME: should we also check to see whether the start
14635 f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6575 // time is after the beginning of this Octave session?
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6576 }
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6577 else
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6578 error ("toc: invalid ID");
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6579 }
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6580
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6581 if (! error_state)
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6582 {
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6583 if (start_time < 0)
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6584 error ("toc called before timer set");
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6585 else
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6586 {
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6587 octave_time now;
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6588
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6589 double tmp = now.double_value () - start_time;
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6590
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6591 if (nargout > 0)
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6592 retval = tmp;
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6593 else
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6594 octave_stdout << "Elapsed time is " << tmp << " seconds.\n";
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6595 }
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6596 }
7065 97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe] jwe parents: 7045 diff changeset	6597 }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	6598
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6599 return retval;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6600 }
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6601
14635 f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6602 /*
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6603 %!shared id
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6604 %! id = tic ();
14849 f6d3d5b0bd42 test: Use Octave coding conventions for tests for line() and toc(). Rik <octave@nomad.inbox5.com> parents: 14846 diff changeset	6605 %!assert (isa (id, "uint64"))
f6d3d5b0bd42 test: Use Octave coding conventions for tests for line() and toc(). Rik <octave@nomad.inbox5.com> parents: 14846 diff changeset	6606 %!assert (isa (toc (id), "double"))
14635 f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6607 */
f8d5095fa90d improve compatibility of tic and toc John W. Eaton <jwe@octave.org> parents: 14615 diff changeset	6608
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6609 DEFUN (cputime, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6610 "-- texinfo --\n\
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6611 @deftypefn {Built-in Function} {[@var{total}, @var{user}, @var{system}] =} cputime ();\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6612 Return the CPU time used by your Octave session.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6613 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6614 The first output is the total time spent executing your process and is equal\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6615 to the sum of second and third outputs, which are the number of CPU seconds\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6616 spent executing in user mode and the number of CPU seconds spent executing\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6617 in system mode, respectively.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6618 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6619 If your system does not have a way to report CPU time usage, @code{cputime}\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6620 returns 0 for each of its output values.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6621 \n\
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6622 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	6623 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	6624 CPU time used is nonzero.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	6625 @seealso{tic, toc}\n\
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6626 @end deftypefn")
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6627 {
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6628 octave_value_list retval;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6629 int nargin = args.length ();
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6630 double usr = 0.0;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6631 double sys = 0.0;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6632
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6633 if (nargin != 0)
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6634 warning ("tic: ignoring extra arguments");
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6635
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6636 #if defined (HAVE_GETRUSAGE)
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6637
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6638 struct rusage ru;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6639
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6640 getrusage (RUSAGE_SELF, &ru);
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6641
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6642 usr = static_cast<double> (ru.ru_utime.tv_sec) +
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6643 static_cast<double> (ru.ru_utime.tv_usec) * 1e-6;
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6644
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6645 sys = static_cast<double> (ru.ru_stime.tv_sec) +
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6646 static_cast<double> (ru.ru_stime.tv_usec) * 1e-6;
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6647
10240 fa7b5751730c use gnulib time, sys_time, and sys_times modules John W. Eaton <jwe@octave.org> parents: 10185 diff changeset	6648 #else
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6649
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6650 struct tms t;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6651
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6652 times (&t);
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6653
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6654 unsigned long ticks;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6655 unsigned long seconds;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6656 unsigned long fraction;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6657
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6658 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	6659 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	6660 seconds = ticks / CLOCKS_PER_SEC;
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6661
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6662 usr = static_cast<double> (seconds) + static_cast<double>(fraction) /
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6663 static_cast<double>(CLOCKS_PER_SEC);
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6664
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6665 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	6666 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	6667 seconds = ticks / CLOCKS_PER_SEC;
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6668
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6669 sys = static_cast<double> (seconds) + static_cast<double>(fraction) /
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6670 static_cast<double>(CLOCKS_PER_SEC);
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6671
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6672 #endif
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6673
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	6674 retval(2) = sys;
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	6675 retval(1) = usr;
7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	6676 retval(0) = sys + usr;
7045 271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6677
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6678 return retval;
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6679 }
271fa61d8fae [project @ 2007-10-22 11:52:38 by dbateman] dbateman parents: 7026 diff changeset	6680
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6681 DEFUN (sort, args, nargout,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6682 "-- texinfo --\n\
15038 ab18578c2ade doc: Update docstrings for built-in functions to not use "Loadable Function" as type. Rik <rik@octave.org> parents: 15034 diff changeset	6683 @deftypefn {Built-in Function} {[@var{s}, @var{i}] =} sort (@var{x})\n\
ab18578c2ade doc: Update docstrings for built-in functions to not use "Loadable Function" as type. Rik <rik@octave.org> parents: 15034 diff changeset	6684 @deftypefnx {Built-in Function} {[@var{s}, @var{i}] =} sort (@var{x}, @var{dim})\n\
ab18578c2ade doc: Update docstrings for built-in functions to not use "Loadable Function" as type. Rik <rik@octave.org> parents: 15034 diff changeset	6685 @deftypefnx {Built-in Function} {[@var{s}, @var{i}] =} sort (@var{x}, @var{mode})\n\
ab18578c2ade doc: Update docstrings for built-in functions to not use "Loadable Function" as type. Rik <rik@octave.org> parents: 15034 diff changeset	6686 @deftypefnx {Built-in Function} {[@var{s}, @var{i}] =} sort (@var{x}, @var{dim}, @var{mode})\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6687 Return a copy of @var{x} with the elements arranged in increasing order.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6688 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	6689 For matrices, @code{sort} orders the elements within columns\n\
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6690 \n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	6691 For example:\n\
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6692 \n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6693 @example\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6694 @group\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6695 sort ([1, 2; 2, 3; 3, 1])\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	6696 @result{} 1 1\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	6697 2 2\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	6698 3 3\n\
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6699 @end group\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6700 @end example\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6701 \n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	6702 If the optional argument @var{dim} is given, then the matrix is sorted\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	6703 along the dimension defined by @var{dim}. The optional argument @code{mode}\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	6704 defines the order in which the values will be sorted. Valid values of\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	6705 @code{mode} are @qcode{\"ascend\"} or @qcode{\"descend\"}.\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	6706 \n\
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6707 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	6708 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	6709 matrix. For example:\n\
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6710 \n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6711 @example\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6712 @group\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6713 [s, i] = sort ([1, 2; 2, 3; 3, 1])\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	6714 @result{} s = 1 1\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	6715 2 2\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	6716 3 3\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	6717 @result{} i = 1 3\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	6718 2 1\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	6719 3 2\n\
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6720 @end group\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6721 @end example\n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6722 \n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	6723 For equal elements, the indices are such that equal elements are listed\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	6724 in the order in which they appeared in the original list.\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	6725 \n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	6726 Sorting of complex entries is done first by magnitude (@code{abs (@var{z})})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	6727 and for any ties by phase angle (@code{angle (z)}). For example:\n\
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6728 \n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	6729 @example\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	6730 @group\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	6731 sort ([1+i; 1; 1-i])\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	6732 @result{} 1 + 0i\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	6733 1 - 1i\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	6734 1 + 1i\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	6735 @end group\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	6736 @end example\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	6737 \n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	6738 NaN values are treated as being greater than any other value and are sorted\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	6739 to the end of the list.\n\
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6740 \n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6741 The @code{sort} function may also be used to sort strings and cell arrays\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	6742 of strings, in which case ASCII dictionary order (uppercase 'A' precedes\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	6743 lowercase 'a') of the strings is used.\n\
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6744 \n\
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6745 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	6746 ordered lists.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	6747 @seealso{sortrows, issorted}\n\
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6748 @end deftypefn")
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6749 {
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6750 octave_value_list retval;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6751
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6752 int nargin = args.length ();
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6753 sortmode smode = ASCENDING;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6754
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6755 if (nargin < 1 \|\| nargin > 3)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6756 {
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6757 print_usage ();
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6758 return retval;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6759 }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6760
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6761 bool return_idx = nargout > 1;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6762
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6763 octave_value arg = args(0);
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6764
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6765 int dim = 0;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6766 if (nargin > 1)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6767 {
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6768 if (args(1).is_string ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6769 {
14846 460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists. Rik <octave@nomad.inbox5.com> parents: 14843 diff changeset	6770 std::string mode = args(1).string_value ();
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6771 if (mode == "ascend")
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6772 smode = ASCENDING;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6773 else if (mode == "descend")
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6774 smode = DESCENDING;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6775 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6776 {
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	6777 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	6778 return retval;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6779 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6780 }
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6781 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6782 dim = args(1).nint_value () - 1;
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6783 }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6784
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6785 if (nargin > 2)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6786 {
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6787 if (args(1).is_string ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6788 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6789 print_usage ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6790 return retval;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6791 }
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6792
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6793 if (! args(2).is_string ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6794 {
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	6795 error ("sort: MODE must be a string");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6796 return retval;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6797 }
14846 460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists. Rik <octave@nomad.inbox5.com> parents: 14843 diff changeset	6798 std::string mode = args(2).string_value ();
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6799 if (mode == "ascend")
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6800 smode = ASCENDING;
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6801 else if (mode == "descend")
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6802 smode = DESCENDING;
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6803 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6804 {
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	6805 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	6806 return retval;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6807 }
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6808 }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6809
10285 22a7913bbeb5 optimize return values of find and sort Jaroslav Hajek <highegg@gmail.com> parents: 10277 diff changeset	6810 const dim_vector dv = arg.dims ();
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6811 if (nargin == 1 \|\| args(1).is_string ())
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6812 {
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6813 // Find first non singleton dimension
10285 22a7913bbeb5 optimize return values of find and sort Jaroslav Hajek <highegg@gmail.com> parents: 10277 diff changeset	6814 dim = dv.first_non_singleton ();
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6815 }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6816 else
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6817 {
10703 5eb420d92307 fix sort and nth_element when trailing singleton dim is specified Jaroslav Hajek <highegg@gmail.com> parents: 10695 diff changeset	6818 if (dim < 0)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6819 {
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	6820 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	6821 return retval;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	6822 }
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6823 }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6824
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6825 if (return_idx)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6826 {
14022 de90542b7afc Return retval(1) before retval(0) to avoid re-sizing call on retval. Rik <octave@nomad.inbox5.com> parents: 13929 diff changeset	6827 retval.resize (2);
de90542b7afc Return retval(1) before retval(0) to avoid re-sizing call on retval. Rik <octave@nomad.inbox5.com> parents: 13929 diff changeset	6828
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6829 Array<octave_idx_type> sidx;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6830
14843 7d4f87c75dbb data.cc: Use Octave coding conventions for cuddling/non-cuddling of parenthesis. Rik <octave@nomad.inbox5.com> parents: 14635 diff changeset	6831 retval(0) = arg.sort (sidx, dim, smode);
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	6832 retval(1) = idx_vector (sidx, dv(dim)); // No checking, extent is known.
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6833 }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6834 else
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6835 retval(0) = arg.sort (dim, smode);
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6836
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6837 return retval;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6838 }
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6839
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6840 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6841 ## Double
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6842 %!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	6843 %!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	6844 %!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	6845 %!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	6846 %!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	6847 %!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	6848 %!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	6849 %!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	6850 %!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	6851 %!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	6852 %!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	6853 %!assert (sort (1), 1)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6854
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6855 %!test
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6856 %! [v, i] = sort ([NaN, 1, -1, Inf, 1]);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6857 %! assert (v, [-1, 1, 1, Inf, NaN]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6858 %! assert (i, [3, 2, 5, 4, 1]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6859
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6860 ## Complex
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6861 %!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	6862 %!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	6863 %!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	6864 %!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	6865 %!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	6866 %!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	6867 %!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	6868 %!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	6869 %!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	6870 %!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	6871 %!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	6872 %!assert (sort (1i), 1i)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6873
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6874 %!test
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6875 %! [v, i] = sort ([NaN, 1i, -1, Inf, 1, 1i]);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6876 %! assert (v, [1, 1i, 1i, -1, Inf, NaN]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6877 %! assert (i, [5, 2, 6, 3, 4, 1]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6878
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6879 ## Single
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6880 %!assert (sort (single ([NaN, 1, -1, 2, Inf])), single ([-1, 1, 2, Inf, NaN]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6881 %!assert (sort (single ([NaN, 1, -1, 2, Inf]), 1), single ([NaN, 1, -1, 2, Inf]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6882 %!assert (sort (single ([NaN, 1, -1, 2, Inf]), 2), single ([-1, 1, 2, Inf, NaN]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6883 %!assert (sort (single ([NaN, 1, -1, 2, Inf]), 3), single ([NaN, 1, -1, 2, Inf]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6884 %!assert (sort (single ([NaN, 1, -1, 2, Inf]), "ascend"), single ([-1, 1, 2, Inf, NaN]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6885 %!assert (sort (single ([NaN, 1, -1, 2, Inf]), 2, "ascend"), single ([-1, 1, 2, Inf, NaN]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6886 %!assert (sort (single ([NaN, 1, -1, 2, Inf]), "descend"), single ([NaN, Inf, 2, 1, -1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6887 %!assert (sort (single ([NaN, 1, -1, 2, Inf]), 2, "descend"), single ([NaN, Inf, 2, 1, -1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6888 %!assert (sort (single ([3, 1, 7, 5; 8, 2, 6, 4])), single ([3, 1, 6, 4; 8, 2, 7, 5]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6889 %!assert (sort (single ([3, 1, 7, 5; 8, 2, 6, 4]), 1), single ([3, 1, 6, 4; 8, 2, 7, 5]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6890 %!assert (sort (single ([3, 1, 7, 5; 8, 2, 6, 4]), 2), single ([1, 3, 5, 7; 2, 4, 6, 8]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6891 %!assert (sort (single (1)), single (1))
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6892
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6893 %!test
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6894 %! [v, i] = sort (single ([NaN, 1, -1, Inf, 1]));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6895 %! assert (v, single ([-1, 1, 1, Inf, NaN]));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6896 %! assert (i, [3, 2, 5, 4, 1]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6897
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6898 ## Single Complex
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6899 %!assert (sort (single ([NaN, 1i, -1, 2, Inf])), single ([1i, -1, 2, Inf, NaN]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6900 %!assert (sort (single ([NaN, 1i, -1, 2, Inf]), 1), single ([NaN, 1i, -1, 2, Inf]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6901 %!assert (sort (single ([NaN, 1i, -1, 2, Inf]), 2), single ([1i, -1, 2, Inf, NaN]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6902 %!assert (sort (single ([NaN, 1i, -1, 2, Inf]), 3), single ([NaN, 1i, -1, 2, Inf]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6903 %!assert (sort (single ([NaN, 1i, -1, 2, Inf]), "ascend"), single ([1i, -1, 2, Inf, NaN]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6904 %!assert (sort (single ([NaN, 1i, -1, 2, Inf]), 2, "ascend"), single ([1i, -1, 2, Inf, NaN]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6905 %!assert (sort (single ([NaN, 1i, -1, 2, Inf]), "descend"), single ([NaN, Inf, 2, -1, 1i]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6906 %!assert (sort (single ([NaN, 1i, -1, 2, Inf]), 2, "descend"), single ([NaN, Inf, 2, -1, 1i]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6907 %!assert (sort (single ([3, 1i, 7, 5; 8, 2, 6, 4])), single ([3, 1i, 6, 4; 8, 2, 7, 5]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6908 %!assert (sort (single ([3, 1i, 7, 5; 8, 2, 6, 4]), 1), single ([3, 1i, 6, 4; 8, 2, 7, 5]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6909 %!assert (sort (single ([3, 1i, 7, 5; 8, 2, 6, 4]), 2), single ([1i, 3, 5, 7; 2, 4, 6, 8]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6910 %!assert (sort (single (1i)), single (1i))
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6911
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7795 diff changeset	6912 %!test
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6913 %! [v, i] = sort (single ([NaN, 1i, -1, Inf, 1, 1i]));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6914 %! assert (v, single ([1, 1i, 1i, -1, Inf, NaN]));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6915 %! assert (i, [5, 2, 6, 3, 4, 1]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6916
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6917 ## Bool
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6918 %!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	6919 %!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	6920 %!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	6921 %!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	6922 %!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	6923 %!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	6924 %!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	6925 %!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	6926 %!assert (sort (true), true)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6927
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6928 %!test
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6929 %! [v, i] = sort ([true, false, true, false]);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6930 %! assert (v, [false, false, true, true]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6931 %! assert (i, [2, 4, 1, 3]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6932
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6933 ## Sparse Double
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6934 %!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	6935 %!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	6936 %!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	6937 %!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	6938 %!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	6939 %!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	6940 %!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	6941 %!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	6942
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6943 %!shared a
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6944 %! a = randn (10, 10);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6945 %! a(a < 0) = 0;
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6946 %!assert (sort (sparse (a)), sparse (sort (a)))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6947 %!assert (sort (sparse (a), 1), sparse (sort (a, 1)))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6948 %!assert (sort (sparse (a), 2), sparse (sort (a, 2)))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6949 %!test
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6950 %! [v, i] = sort (a);
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6951 %! [vs, is] = sort (sparse (a));
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6952 %! assert (vs, sparse (v));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6953 %! assert (is, i);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6954
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6955 ## Sparse Complex
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6956 %!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	6957 %!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	6958 %!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	6959 %!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	6960 %!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	6961 %!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	6962 %!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	6963 %!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	6964
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6965 %!shared a
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	6966 %! a = randn (10, 10);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6967 %! a(a < 0) = 0;
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6968 %! a = 1i * a;
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6969 %!assert (sort (sparse (a)), sparse (sort (a)))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6970 %!assert (sort (sparse (a), 1), sparse (sort (a, 1)))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6971 %!assert (sort (sparse (a), 2), sparse (sort (a, 2)))
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6972 %!test
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6973 %! [v, i] = sort (a);
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6974 %! [vs, is] = sort (sparse (a));
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6975 %! assert (vs, sparse (v));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6976 %! assert (is, i);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6977
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6978 ## Sparse Bool
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6979 %!assert (sort (sparse ([true, false, true, false])), sparse ([false, false, true, true]))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6980 %!assert (sort (sparse ([true, false, true, false]), 1), sparse ([true, false, true, false]))
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6981 %!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	6982 %!assert (sort (sparse ([true, false, true, false]), 3), sparse ([true, false, true, false]))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6983 %!assert (sort (sparse ([true, false, true, false]), "ascend"), sparse ([false, false, true, true]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6984 %!assert (sort (sparse ([true, false, true, false]), 2, "ascend"), sparse ([false, false, true, true]))
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6985 %!assert (sort (sparse ([true, false, true, false]), "descend"), sparse ([true, true, false, false]))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6986 %!assert (sort (sparse ([true, false, true, false]), 2, "descend"), sparse ([true, true, false, false]))
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6987
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6988 %!test
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6989 %! [v, i] = sort (sparse ([true, false, true, false]));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6990 %! assert (v, sparse ([false, false, true, true]));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6991 %! assert (i, [2, 4, 1, 3]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6992
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6993 ## Cell string array
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6994 %!shared a, b, c
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6995 %! a = {"Alice", "Cecile", "Eric", "Barry", "David"};
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6996 %! b = {"Alice", "Barry", "Cecile", "David", "Eric"};
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6997 %! c = {"Eric", "David", "Cecile", "Barry", "Alice"};
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	6998 %!assert (sort (a), b)
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	6999 %!assert (sort (a, 1), a)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7000 %!assert (sort (a, 2), b)
10707 69c5f5ec55d7 fix invalid sort tests Jaroslav Hajek <highegg@gmail.com> parents: 10703 diff changeset	7001 %!assert (sort (a, 3), a)
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7002 %!assert (sort (a, "ascend"), b)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7003 %!assert (sort (a, 2, "ascend"), b)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7004 %!assert (sort (a, "descend"), c)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7005 %!assert (sort (a, 2, "descend"), c)
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7006
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7007 %!test
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7008 %! [v, i] = sort (a);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7009 %! assert (i, [1, 4, 2, 5, 3]);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7010
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7011 %!error sort ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7012 %!error sort (1, 2, 3, 4)
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7013 */
402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7269 diff changeset	7014
8812 7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8799 diff changeset	7015 // Sort the rows of the matrix @var{a} according to the order
15466 d174210ce1ec use ' instead of ` in error messages, warnings and most comments John W. Eaton <jwe@octave.org> parents: 15428 diff changeset	7016 // specified by @var{mode}, which can either be 'ascend' or 'descend'
8812 7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8799 diff changeset	7017 // 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	7018 //
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8799 diff changeset	7019 // 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	7020
8733 3ef774603887 rename all uses of sortrows_idx to sort_rows_idx John W. Eaton <jwe@octave.org> parents: 8721 diff changeset	7021 DEFUN (__sort_rows_idx__, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7022 "-- texinfo --\n\
9517 a85dbf7b6ff9 fix some functions help markup Jaroslav Hajek <highegg@gmail.com> parents: 9513 diff changeset	7023 @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	7024 Undocumented internal function.\n\
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7025 @end deftypefn\n")
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7026 {
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7027 octave_value retval;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7028
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7029 int nargin = args.length ();
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7030 sortmode smode = ASCENDING;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7031
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7032 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	7033 {
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7034 print_usage ();
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7035 return retval;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7036 }
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7037
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7038 if (nargin > 1)
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7039 {
14846 460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists. Rik <octave@nomad.inbox5.com> parents: 14843 diff changeset	7040 std::string mode = args(1).string_value ();
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7041 if (mode == "ascend")
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7042 smode = ASCENDING;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7043 else if (mode == "descend")
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7044 smode = DESCENDING;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7045 else
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7046 {
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	7047 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	7048 return retval;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7049 }
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7050 }
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7051
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7052 octave_value arg = args(0);
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7053
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7054 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	7055 error ("__sort_rows_idx__: sparse matrices not yet supported");
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7056 if (arg.ndims () == 2)
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7057 {
8733 3ef774603887 rename all uses of sortrows_idx to sort_rows_idx John W. Eaton <jwe@octave.org> parents: 8721 diff changeset	7058 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	7059
9351 e2344f4af0cb autocache indices returned from find et al. Jaroslav Hajek <highegg@gmail.com> parents: 9339 diff changeset	7060 retval = octave_value (idx, true, true);
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7061 }
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7062 else
8733 3ef774603887 rename all uses of sortrows_idx to sort_rows_idx John W. Eaton <jwe@octave.org> parents: 8721 diff changeset	7063 error ("__sort_rows_idx__: needs a 2-dimensional object");
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7064
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7065 return retval;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7066 }
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7067
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7068 static sortmode
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7069 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	7070 {
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7071 // FIXME: we initialize to UNSORTED here to avoid a GCC warning
10076 4b270d1540f7 avoid various GCC warnings John W. Eaton <jwe@octave.org> parents: 10073 diff changeset	7072 // about possibly using sortmode uninitialized.
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7073 // FIXME: shouldn't these modes be scoped inside a class?
10076 4b270d1540f7 avoid various GCC warnings John W. Eaton <jwe@octave.org> parents: 10073 diff changeset	7074 sortmode smode = UNSORTED;
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7075
19437 03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19435 diff changeset	7076 if (arg.is_string ())
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19435 diff changeset	7077 {
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19435 diff changeset	7078 std::string mode = arg.string_value ();
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19435 diff changeset	7079 if (mode == "ascending")
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19435 diff changeset	7080 smode = ASCENDING;
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19435 diff changeset	7081 else if (mode == "descending")
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19435 diff changeset	7082 smode = DESCENDING;
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19435 diff changeset	7083 else if (mode == "either")
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19435 diff changeset	7084 smode = UNSORTED;
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19435 diff changeset	7085 else
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19435 diff changeset	7086 error ("issorted: MODE must be \"ascending\", \"descending\", or \"either\"");
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19435 diff changeset	7087 }
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7088 else
19437 03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19435 diff changeset	7089 error ("issorted: expecting %s argument to be a string", argn);
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7090
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7091 return smode;
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7092 }
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7093
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7094 DEFUN (issorted, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7095 "-- texinfo --\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	7096 @deftypefn {Built-in Function} {} issorted (@var{a})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	7097 @deftypefnx {Built-in Function} {} issorted (@var{a}, @var{mode})\n\
12681 c09ed93d1a8b doc: Don't use @code{} within @deftypefn macro Rik <octave@nomad.inbox5.com> parents: 12642 diff changeset	7098 @deftypefnx {Built-in Function} {} issorted (@var{a}, \"rows\", @var{mode})\n\
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	7099 Return true if the array is sorted according to @var{mode}, which\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	7100 may be either @qcode{\"ascending\"}, @qcode{\"descending\"}, or\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7101 @qcode{\"either\"}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7102 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7103 By default, @var{mode} is @qcode{\"ascending\"}. NaNs are treated in the\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7104 same manner as @code{sort}.\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	7105 \n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	7106 If the optional argument @qcode{\"rows\"} is supplied, check whether\n\
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	7107 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	7108 (with no options).\n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	7109 \n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	7110 This function does not support sparse matrices.\n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11422 diff changeset	7111 @seealso{sort, sortrows}\n\
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7112 @end deftypefn\n")
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7113 {
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7114 octave_value retval;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7115
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7116 int nargin = args.length ();
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7117
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7118 if (nargin < 1 \|\| nargin > 3)
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7119 {
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7120 print_usage ();
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7121 return retval;
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7122 }
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7123
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7124 bool by_rows = false;
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7125
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7126 sortmode smode = ASCENDING;
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7127
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7128 if (nargin > 1)
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7129 {
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7130 octave_value mode_arg;
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7131
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7132 if (nargin == 3)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	7133 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	7134
19437 03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19435 diff changeset	7135 if (args(1).is_string ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	7136 {
19437 03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19435 diff changeset	7137 std::string tmp = args(1).string_value ();
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	7138 if (tmp == "rows")
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	7139 by_rows = true;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	7140 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	7141 smode = get_sort_mode_option (args(1), "second");
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	7142 }
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7143 else
19437 03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19435 diff changeset	7144 error ("issorted: second argument must be a string");
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7145
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7146 if (error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	7147 return retval;
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7148 }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	7149
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7150 octave_value arg = args(0);
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7151
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7152 if (by_rows)
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7153 {
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7154 if (arg.is_sparse_type ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	7155 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	7156 if (arg.ndims () == 2)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	7157 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	7158 else
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	7159 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	7160 }
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7161 else
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7162 {
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7163 if (arg.dims ().is_vector ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10303 diff changeset	7164 retval = args(0).is_sorted (smode) != UNSORTED;
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7165 else
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7166 error ("issorted: needs a vector");
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7167 }
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7168
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7169 return retval;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7170 }
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7171
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7172 /*
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7173 %!shared sm, um, sv, uv
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7174 %! sm = [1, 2; 3, 4];
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7175 %! um = [3, 1; 2, 4];
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7176 %! sv = [1, 2, 3, 4];
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7177 %! uv = [2, 1, 4, 3];
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7178 %!assert (issorted (sm, "rows"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7179 %!assert (!issorted (um, "rows"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7180 %!assert (issorted (sv))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7181 %!assert (!issorted (uv))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7182 %!assert (issorted (sv'))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7183 %!assert (!issorted (uv'))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7184 %!assert (issorted (sm, "rows", "ascending"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7185 %!assert (!issorted (um, "rows", "ascending"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7186 %!assert (issorted (sv, "ascending"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7187 %!assert (!issorted (uv, "ascending"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7188 %!assert (issorted (sv', "ascending"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7189 %!assert (!issorted (uv', "ascending"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7190 %!assert (!issorted (sm, "rows", "descending"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7191 %!assert (issorted (flipud (sm), "rows", "descending"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7192 %!assert (!issorted (sv, "descending"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7193 %!assert (issorted (fliplr (sv), "descending"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7194 %!assert (!issorted (sv', "descending"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7195 %!assert (issorted (fliplr (sv)', "descending"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7196 %!assert (!issorted (um, "rows", "either"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7197 %!assert (!issorted (uv, "either"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7198 %!assert (issorted (sm, "rows", "either"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7199 %!assert (issorted (flipud (sm), "rows", "either"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7200 %!assert (issorted (sv, "either"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7201 %!assert (issorted (fliplr (sv), "either"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7202 %!assert (issorted (sv', "either"))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7203 %!assert (issorted (fliplr (sv)', "either"))
9765 7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7204 */
7fc1c8c47b86 issorted: new option for sort mode John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	7205
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7206 DEFUN (nth_element, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7207 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	7208 @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	7209 @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	7210 Select the n-th smallest element of a vector, using the ordering defined by\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7211 @code{sort}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7212 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7213 The result is equivalent to @code{sort(@var{x})(@var{n})}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7214 \n\
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7215 @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	7216 or descending @code{u:-1:l}, in which case a range of elements is returned.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7217 \n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	7218 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	7219 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	7220 not given.\n\
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7221 \n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7222 Programming Note: nth_element encapsulates the C++ standard library\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7223 algorithms nth_element and partial_sort. On average, the complexity of the\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7224 operation is O(M*log(K)), where @w{@code{M = size (@var{x}, @var{dim})}} and\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7225 @w{@code{K = length (@var{n})}}. This function is intended for cases where\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7226 the ratio K/M is small; otherwise, it may be better to use @code{sort}.\n\
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7227 @seealso{sort, min, max}\n\
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7228 @end deftypefn")
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7229 {
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7230 octave_value retval;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7231 int nargin = args.length ();
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7232
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7233 if (nargin == 2 \|\| nargin == 3)
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7234 {
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7235 octave_value argx = args(0);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7236
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7237 int dim = -1;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7238 if (nargin == 3)
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7239 {
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7240 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	7241 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	7242 error ("nth_element: DIM must be a valid dimension");
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7243 }
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7244 if (dim < 0)
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7245 dim = argx.dims ().first_non_singleton ();
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7246
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7247 idx_vector n = args(1).index_vector ();
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7248
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7249 if (error_state)
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7250 return retval;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7251
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7252 switch (argx.builtin_type ())
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7253 {
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7254 case btyp_double:
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7255 retval = argx.array_value ().nth_element (n, dim);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7256 break;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7257 case btyp_float:
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7258 retval = argx.float_array_value ().nth_element (n, dim);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7259 break;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7260 case btyp_complex:
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7261 retval = argx.complex_array_value ().nth_element (n, dim);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7262 break;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7263 case btyp_float_complex:
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7264 retval = argx.float_complex_array_value ().nth_element (n, dim);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7265 break;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7266 #define MAKE_INT_BRANCH(X) \
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7267 case btyp_ ## X: \
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7268 retval = argx.X ## _array_value ().nth_element (n, dim); \
18760 5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18759 diff changeset	7269 break;
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7270
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7271 MAKE_INT_BRANCH (int8);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7272 MAKE_INT_BRANCH (int16);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7273 MAKE_INT_BRANCH (int32);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7274 MAKE_INT_BRANCH (int64);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7275 MAKE_INT_BRANCH (uint8);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7276 MAKE_INT_BRANCH (uint16);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7277 MAKE_INT_BRANCH (uint32);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7278 MAKE_INT_BRANCH (uint64);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7279 #undef MAKE_INT_BRANCH
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7280 default:
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7281 if (argx.is_cellstr ())
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7282 retval = argx.cellstr_value ().nth_element (n, dim);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7283 else
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7284 gripe_wrong_type_arg ("nth_element", argx);
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7285 }
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7286 }
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7287 else
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7288 print_usage ();
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7289
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7290 return retval;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7291 }
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9723 diff changeset	7292
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7293 template <class NDT>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	7294 static NDT
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7295 do_accumarray_sum (const idx_vector& idx, const NDT& vals,
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7296 octave_idx_type n = -1)
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7297 {
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7298 typedef typename NDT::element_type T;
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7299 if (n < 0)
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7300 n = idx.extent (0);
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7301 else if (idx.extent (n) > n)
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7302 error ("accumarray: index out of range");
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7303
14846 460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists. Rik <octave@nomad.inbox5.com> parents: 14843 diff changeset	7304 NDT retval (dim_vector (n, 1), T ());
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7305
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7306 if (vals.numel () == 1)
9858 47c5af1868df move idx_add methods to MArrayN Jaroslav Hajek <highegg@gmail.com> parents: 9856 diff changeset	7307 retval.idx_add (idx, vals (0));
47c5af1868df move idx_add methods to MArrayN Jaroslav Hajek <highegg@gmail.com> parents: 9856 diff changeset	7308 else if (vals.numel () == idx.length (n))
47c5af1868df move idx_add methods to MArrayN Jaroslav Hajek <highegg@gmail.com> parents: 9856 diff changeset	7309 retval.idx_add (idx, vals);
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7310 else
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7311 error ("accumarray: dimensions mismatch");
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7312
9858 47c5af1868df move idx_add methods to MArrayN Jaroslav Hajek <highegg@gmail.com> parents: 9856 diff changeset	7313 return retval;
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7314 }
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7315
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7316 DEFUN (__accumarray_sum__, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7317 "-- texinfo --\n\
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7318 @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	7319 Undocumented internal function.\n\
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7320 @end deftypefn")
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7321 {
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7322 octave_value retval;
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7323 int nargin = args.length ();
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7324 if (nargin >= 2 && nargin <= 3 && args(0).is_numeric_type ())
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7325 {
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7326 idx_vector idx = args(0).index_vector ();
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7327 octave_idx_type n = -1;
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7328 if (nargin == 3)
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7329 n = args(2).idx_type_value (true);
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7330
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7331 if (! error_state)
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7332 {
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7333 octave_value vals = args(1);
9198 3b9aacf07744 optimize accumarray with constant ranges Jaroslav Hajek <highegg@gmail.com> parents: 9197 diff changeset	7334 if (vals.is_range ())
3b9aacf07744 optimize accumarray with constant ranges Jaroslav Hajek <highegg@gmail.com> parents: 9197 diff changeset	7335 {
3b9aacf07744 optimize accumarray with constant ranges Jaroslav Hajek <highegg@gmail.com> parents: 9197 diff changeset	7336 Range r = vals.range_value ();
3b9aacf07744 optimize accumarray with constant ranges Jaroslav Hajek <highegg@gmail.com> parents: 9197 diff changeset	7337 if (r.inc () == 0)
3b9aacf07744 optimize accumarray with constant ranges Jaroslav Hajek <highegg@gmail.com> parents: 9197 diff changeset	7338 vals = r.base ();
3b9aacf07744 optimize accumarray with constant ranges Jaroslav Hajek <highegg@gmail.com> parents: 9197 diff changeset	7339 }
3b9aacf07744 optimize accumarray with constant ranges Jaroslav Hajek <highegg@gmail.com> parents: 9197 diff changeset	7340
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7341 if (vals.is_single_type ())
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7342 {
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7343 if (vals.is_complex_type ())
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19433 diff changeset	7344 retval = do_accumarray_sum (idx,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7345 vals.float_complex_array_value (),
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7346 n);
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7347 else
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7348 retval = do_accumarray_sum (idx, vals.float_array_value (), n);
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7349 }
10269 217d36560dfa small fixes to accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10268 diff changeset	7350 else if (vals.is_numeric_type () \|\| vals.is_bool_type ())
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7351 {
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7352 if (vals.is_complex_type ())
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7353 retval = do_accumarray_sum (idx,
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7354 vals.complex_array_value (),
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7355 n);
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7356 else
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7357 retval = do_accumarray_sum (idx, vals.array_value (), n);
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7358 }
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7359 else
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7360 gripe_wrong_type_arg ("accumarray", vals);
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7361 }
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7362 }
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7363 else
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7364 print_usage ();
c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7365
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	7366 return retval;
8934 c2099a4d12ea partially optimize accumarray Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	7367 }
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7368
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7369 template <class NDT>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	7370 static NDT
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7371 do_accumarray_minmax (const idx_vector& idx, const NDT& vals,
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7372 octave_idx_type n, bool ismin,
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7373 const typename NDT::element_type& zero_val)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7374 {
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7375 typedef typename NDT::element_type T;
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7376 if (n < 0)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7377 n = idx.extent (0);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7378 else if (idx.extent (n) > n)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7379 error ("accumarray: index out of range");
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7380
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7381 NDT retval (dim_vector (n, 1), zero_val);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7382
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7383 // Pick minimizer or maximizer.
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	7384 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	7385 ismin ? (&MArray<T>::idx_min) : (&MArray<T>::idx_max);
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7386
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7387 octave_idx_type l = idx.length (n);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7388 if (vals.numel () == 1)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7389 (retval.*op) (idx, NDT (dim_vector (l, 1), vals(0)));
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7390 else if (vals.numel () == l)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7391 (retval.*op) (idx, vals);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7392 else
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7393 error ("accumarray: dimensions mismatch");
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7394
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7395 return retval;
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7396 }
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7397
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7398 static octave_value_list
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7399 do_accumarray_minmax_fun (const octave_value_list& args,
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7400 bool ismin)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7401 {
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7402 octave_value retval;
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7403 int nargin = args.length ();
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7404 if (nargin >= 3 && nargin <= 4 && args(0).is_numeric_type ())
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7405 {
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7406 idx_vector idx = args(0).index_vector ();
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7407 octave_idx_type n = -1;
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7408 if (nargin == 4)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7409 n = args(3).idx_type_value (true);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7410
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7411 if (! error_state)
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7412 {
18099 6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	7413 octave_value vals = args(1);
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	7414 octave_value zero = args(2);
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7415
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7416 switch (vals.builtin_type ())
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7417 {
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7418 case btyp_double:
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7419 retval = do_accumarray_minmax (idx, vals.array_value (), n, ismin,
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7420 zero.double_value ());
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7421 break;
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7422 case btyp_float:
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7423 retval = do_accumarray_minmax (idx, vals.float_array_value (), n,
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7424 ismin, zero.float_value ());
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7425 break;
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7426 case btyp_complex:
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7427 retval = do_accumarray_minmax (idx, vals.complex_array_value (),
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7428 n, ismin, zero.complex_value ());
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7429 break;
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7430 case btyp_float_complex:
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7431 retval = do_accumarray_minmax (idx,
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7432 vals.float_complex_array_value (),
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7433 n, ismin,
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7434 zero.float_complex_value ());
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7435 break;
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7436 #define MAKE_INT_BRANCH(X) \
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7437 case btyp_ ## X: \
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7438 retval = do_accumarray_minmax (idx, vals.X ## _array_value (), \
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7439 n, ismin, \
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7440 zero.X ## _scalar_value ()); \
18760 5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18759 diff changeset	7441 break;
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7442
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7443 MAKE_INT_BRANCH (int8);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7444 MAKE_INT_BRANCH (int16);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7445 MAKE_INT_BRANCH (int32);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7446 MAKE_INT_BRANCH (int64);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7447 MAKE_INT_BRANCH (uint8);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7448 MAKE_INT_BRANCH (uint16);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7449 MAKE_INT_BRANCH (uint32);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7450 MAKE_INT_BRANCH (uint64);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7451 #undef MAKE_INT_BRANCH
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7452 case btyp_bool:
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7453 retval = do_accumarray_minmax (idx, vals.array_value (), n, ismin,
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7454 zero.bool_value ());
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7455 break;
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7456 default:
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7457 gripe_wrong_type_arg ("accumarray", vals);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7458 }
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7459 }
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7460 }
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7461 else
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7462 print_usage ();
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7463
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	7464 return retval;
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7465 }
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7466
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7467 DEFUN (__accumarray_min__, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7468 "-- texinfo --\n\
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7469 @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	7470 Undocumented internal function.\n\
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7471 @end deftypefn")
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7472 {
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7473 return do_accumarray_minmax_fun (args, true);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7474 }
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7475
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7476 DEFUN (__accumarray_max__, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7477 "-- texinfo --\n\
10268 9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7478 @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	7479 Undocumented internal function.\n\
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7480 @end deftypefn")
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7481 {
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7482 return do_accumarray_minmax_fun (args, false);
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7483 }
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7484
9a16a61ed43d new optimizations for accumarray Jaroslav Hajek <highegg@gmail.com> parents: 10240 diff changeset	7485 template <class NDT>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	7486 static NDT
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7487 do_accumdim_sum (const idx_vector& idx, const NDT& vals,
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7488 int dim = -1, octave_idx_type n = -1)
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7489 {
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7490 typedef typename NDT::element_type T;
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7491 if (n < 0)
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7492 n = idx.extent (0);
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7493 else if (idx.extent (n) > n)
14113 dac62c415e8b Do more error checking on accumarray and accumdim input. Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14100 diff changeset	7494 error ("accumdim: index out of range");
dac62c415e8b Do more error checking on accumarray and accumdim input. Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14100 diff changeset	7495
18099 6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	7496 dim_vector vals_dim = vals.dims ();
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	7497 dim_vector rdv = vals_dim;
14113 dac62c415e8b Do more error checking on accumarray and accumdim input. Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14100 diff changeset	7498
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7499 if (dim < 0)
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7500 dim = vals.dims ().first_non_singleton ();
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7501 else if (dim >= rdv.length ())
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7502 rdv.resize (dim+1, 1);
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7503
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7504 rdv(dim) = n;
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7505
14846 460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists. Rik <octave@nomad.inbox5.com> parents: 14843 diff changeset	7506 NDT retval (rdv, T ());
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7507
14113 dac62c415e8b Do more error checking on accumarray and accumdim input. Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14100 diff changeset	7508 if (idx.length () != vals_dim(dim))
dac62c415e8b Do more error checking on accumarray and accumdim input. Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14100 diff changeset	7509 error ("accumdim: dimension mismatch");
dac62c415e8b Do more error checking on accumarray and accumdim input. Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14100 diff changeset	7510
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7511 retval.idx_add_nd (idx, vals, dim);
14113 dac62c415e8b Do more error checking on accumarray and accumdim input. Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14100 diff changeset	7512
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7513 return retval;
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7514 }
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7515
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7516 DEFUN (__accumdim_sum__, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7517 "-- texinfo --\n\
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7518 @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	7519 Undocumented internal function.\n\
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7520 @end deftypefn")
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7521 {
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7522 octave_value retval;
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7523 int nargin = args.length ();
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7524 if (nargin >= 2 && nargin <= 4 && args(0).is_numeric_type ())
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7525 {
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7526 idx_vector idx = args(0).index_vector ();
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7527 int dim = -1;
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7528 if (nargin >= 3)
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7529 dim = args(2).int_value () - 1;
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7530
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7531 octave_idx_type n = -1;
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7532 if (nargin == 4)
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7533 n = args(3).idx_type_value (true);
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7534
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7535 if (! error_state)
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7536 {
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7537 octave_value vals = args(1);
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7538
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7539 if (vals.is_single_type ())
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7540 {
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7541 if (vals.is_complex_type ())
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7542 retval = do_accumdim_sum (idx,
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7543 vals.float_complex_array_value (),
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7544 dim, n);
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7545 else
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7546 retval = do_accumdim_sum (idx, vals.float_array_value (),
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7547 dim, n);
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7548 }
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7549 else if (vals.is_numeric_type () \|\| vals.is_bool_type ())
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7550 {
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7551 if (vals.is_complex_type ())
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7552 retval = do_accumdim_sum (idx, vals.complex_array_value (),
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7553 dim, n);
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7554 else
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7555 retval = do_accumdim_sum (idx, vals.array_value (), dim, n);
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7556 }
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7557 else
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7558 gripe_wrong_type_arg ("accumdim", vals);
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7559 }
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7560 }
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7561 else
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7562 print_usage ();
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7563
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	7564 return retval;
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7565 }
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7566
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	7567 template <class NDT>
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7568 static NDT
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7569 do_merge (const Array<bool>& mask,
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7570 const NDT& tval, const NDT& fval)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7571 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7572 typedef typename NDT::element_type T;
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7573 dim_vector dv = mask.dims ();
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7574 NDT retval (dv);
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7575
18099 6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	7576 bool tscl = tval.numel () == 1;
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	7577 bool fscl = fval.numel () == 1;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	7578
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7579 if ((! tscl && tval.dims () != dv)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7580 \|\| (! 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	7581 error ("merge: MASK, TVAL, and FVAL dimensions must match");
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7582 else
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7583 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7584 T *rv = retval.fortran_vec ();
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7585 octave_idx_type n = retval.numel ();
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7586
18099 6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	7587 const T *tv = tval.data ();
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	7588 const T *fv = fval.data ();
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7589 const bool *mv = mask.data ();
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7590
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7591 if (tscl)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7592 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7593 if (fscl)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7594 {
18099 6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	7595 T ts = tv[0];
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	7596 T fs = fv[0];
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7597 for (octave_idx_type i = 0; i < n; i++)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7598 rv[i] = mv[i] ? ts : fs;
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7599 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7600 else
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7601 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7602 T ts = tv[0];
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7603 for (octave_idx_type i = 0; i < n; i++)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7604 rv[i] = mv[i] ? ts : fv[i];
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7605 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7606 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7607 else
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7608 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7609 if (fscl)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7610 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7611 T fs = fv[0];
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7612 for (octave_idx_type i = 0; i < n; i++)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7613 rv[i] = mv[i] ? tv[i] : fs;
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7614 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7615 else
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7616 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7617 for (octave_idx_type i = 0; i < n; i++)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7618 rv[i] = mv[i] ? tv[i] : fv[i];
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7619 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7620 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7621 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7622
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7623 return retval;
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7624 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7625
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7626 #define MAKE_INT_BRANCH(INTX) \
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7627 else if (tval.is_ ## INTX ## _type () && fval.is_ ## INTX ## _type ()) \
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7628 { \
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7629 retval = do_merge (mask, \
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7630 tval.INTX ## _array_value (), \
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7631 fval.INTX ## _array_value ()); \
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7632 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7633
9505 a321a1c227c8 make ifelse an alias or merge Jaroslav Hajek <highegg@gmail.com> parents: 9475 diff changeset	7634 DEFUN (merge, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7635 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	7636 @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	7637 @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	7638 Merge elements of @var{true_val} and @var{false_val}, depending on the\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7639 value of @var{mask}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7640 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7641 If @var{mask} is a logical scalar, the other two arguments can be arbitrary\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7642 values. Otherwise, @var{mask} must be a logical array, and @var{tval},\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7643 @var{fval} should be arrays of matching class, or cell arrays. In the\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7644 scalar mask case, @var{tval} is returned if @var{mask} is true, otherwise\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7645 @var{fval} is returned.\n\
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7646 \n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	7647 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	7648 scalars or arrays with dimensions equal to @var{mask}. The result is\n\
12642 f96b9b9f141b doc: Periodic grammarcheck and spellcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	7649 constructed as follows:\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	7650 \n\
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7651 @example\n\
9758 09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format Rik <rdrider0-list@yahoo.com> parents: 9736 diff changeset	7652 @group\n\
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7653 result(mask) = tval(mask);\n\
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7654 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	7655 @end group\n\
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7656 @end example\n\
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7657 \n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7658 @var{mask} can also be arbitrary numeric type, in which case it is first\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7659 converted to logical.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	7660 @seealso{logical, diff}\n\
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7661 @end deftypefn")
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7662 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7663 int nargin = args.length ();
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7664 octave_value retval;
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7665
9856 870a69bac55c fix test in merge Jaroslav Hajek <highegg@gmail.com> parents: 9848 diff changeset	7666 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	7667 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7668 octave_value mask_val = args(0);
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7669
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7670 if (mask_val.is_scalar_type ())
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7671 retval = mask_val.is_true () ? args(1) : args(2);
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7672 else
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7673 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7674 boolNDArray mask = mask_val.bool_array_value ();
18099 6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	7675 octave_value tval = args(1);
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	7676 octave_value fval = args(2);
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7677 if (tval.is_double_type () && fval.is_double_type ())
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7678 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7679 if (tval.is_complex_type () \|\| fval.is_complex_type ())
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7680 retval = do_merge (mask,
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7681 tval.complex_array_value (),
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7682 fval.complex_array_value ());
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7683 else
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7684 retval = do_merge (mask,
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7685 tval.array_value (),
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7686 fval.array_value ());
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7687 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7688 else if (tval.is_single_type () && fval.is_single_type ())
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7689 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7690 if (tval.is_complex_type () \|\| fval.is_complex_type ())
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7691 retval = do_merge (mask,
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7692 tval.float_complex_array_value (),
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7693 fval.float_complex_array_value ());
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7694 else
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7695 retval = do_merge (mask,
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7696 tval.float_array_value (),
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7697 fval.float_array_value ());
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7698 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7699 else if (tval.is_string () && fval.is_string ())
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7700 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7701 bool sq_string = tval.is_sq_string () \|\| fval.is_sq_string ();
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7702 retval = octave_value (do_merge (mask,
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7703 tval.char_array_value (),
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7704 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	7705 sq_string ? '\'' : '"');
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7706 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7707 else if (tval.is_cell () && fval.is_cell ())
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7708 {
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7709 retval = do_merge (mask,
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7710 tval.cell_value (),
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7711 fval.cell_value ());
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7712 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7713
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7714 MAKE_INT_BRANCH (int8)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7715 MAKE_INT_BRANCH (int16)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7716 MAKE_INT_BRANCH (int32)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7717 MAKE_INT_BRANCH (int64)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7718 MAKE_INT_BRANCH (uint8)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7719 MAKE_INT_BRANCH (uint16)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7720 MAKE_INT_BRANCH (uint32)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7721 MAKE_INT_BRANCH (uint64)
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7722
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7723 else
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	7724 error ("merge: cannot merge %s with %s with array mask",
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7725 tval.class_name ().c_str (),
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7726 fval.class_name ().c_str ());
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7727 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7728 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7729 else
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7730 print_usage ();
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7731
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7732 return retval;
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7733 }
833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7734
9505 a321a1c227c8 make ifelse an alias or merge Jaroslav Hajek <highegg@gmail.com> parents: 9475 diff changeset	7735 DEFALIAS (ifelse, merge);
a321a1c227c8 make ifelse an alias or merge Jaroslav Hajek <highegg@gmail.com> parents: 9475 diff changeset	7736
9473 833109a9f37f implement merge function Jaroslav Hajek <highegg@gmail.com> parents: 9428 diff changeset	7737 #undef MAKE_INT_BRANCH
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8527 diff changeset	7738
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7739 template <class SparseT>
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7740 static SparseT
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7741 do_sparse_diff (const SparseT& array, octave_idx_type order,
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7742 int dim)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7743 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7744 SparseT retval = array;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7745 if (dim == 1)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7746 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7747 octave_idx_type k = retval.columns ();
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7748 while (order > 0 && k > 0)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7749 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7750 idx_vector col1 (':'), col2 (':'), sl1 (1, k), sl2 (0, k-1);
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7751 retval = SparseT (retval.index (col1, sl1))
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7752 - SparseT (retval.index (col2, sl2));
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7753 assert (retval.columns () == k-1);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7754 order--;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7755 k--;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7756 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7757 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7758 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7759 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7760 octave_idx_type k = retval.rows ();
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7761 while (order > 0 && k > 0)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7762 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7763 idx_vector col1 (':'), col2 (':'), sl1 (1, k), sl2 (0, k-1);
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7764 retval = SparseT (retval.index (sl1, col1))
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7765 - SparseT (retval.index (sl2, col2));
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7766 assert (retval.rows () == k-1);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7767 order--;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7768 k--;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7769 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7770 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7771
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7772 return retval;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7773 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7774
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7775 static octave_value
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7776 do_diff (const octave_value& array, octave_idx_type order,
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7777 int dim = -1)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7778 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7779 octave_value retval;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7780
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7781 const dim_vector& dv = array.dims ();
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7782 if (dim == -1)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7783 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7784 dim = array.dims ().first_non_singleton ();
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7785
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7786 // Bother Matlab. This behavior is really wicked.
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7787 if (dv(dim) <= order)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7788 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7789 if (dv(dim) == 1)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7790 retval = array.resize (dim_vector (0, 0));
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7791 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7792 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7793 retval = array;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7794 while (order > 0)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7795 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7796 if (dim == dv.length ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7797 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7798 retval = do_diff (array, order, dim - 1);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7799 order = 0;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7800 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7801 else if (dv(dim) == 1)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7802 dim++;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7803 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7804 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7805 retval = do_diff (array, dv(dim) - 1, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7806 order -= dv(dim) - 1;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7807 dim++;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7808 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7809 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7810 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7811
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7812 return retval;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7813 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7814 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7815
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7816 if (array.is_integer_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7817 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7818 if (array.is_int8_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7819 retval = array.int8_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7820 else if (array.is_int16_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7821 retval = array.int16_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7822 else if (array.is_int32_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7823 retval = array.int32_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7824 else if (array.is_int64_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7825 retval = array.int64_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7826 else if (array.is_uint8_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7827 retval = array.uint8_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7828 else if (array.is_uint16_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7829 retval = array.uint16_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7830 else if (array.is_uint32_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7831 retval = array.uint32_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7832 else if (array.is_uint64_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7833 retval = array.uint64_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7834 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7835 panic_impossible ();
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7836 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7837 else if (array.is_sparse_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7838 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7839 if (array.is_complex_type ())
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7840 retval = do_sparse_diff (array.sparse_complex_matrix_value (),
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7841 order, dim);
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7842 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7843 retval = do_sparse_diff (array.sparse_matrix_value (), order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7844 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7845 else if (array.is_single_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7846 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7847 if (array.is_complex_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7848 retval = array.float_complex_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7849 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7850 retval = array.float_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7851 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7852 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7853 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7854 if (array.is_complex_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7855 retval = array.complex_array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7856 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7857 retval = array.array_value ().diff (order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7858 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7859
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7860 return retval;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7861 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7862
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7863 DEFUN (diff, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7864 "-- texinfo --\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	7865 @deftypefn {Built-in Function} {} diff (@var{x})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	7866 @deftypefnx {Built-in Function} {} diff (@var{x}, @var{k})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	7867 @deftypefnx {Built-in Function} {} diff (@var{x}, @var{k}, @var{dim})\n\
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	7868 If @var{x} is a vector of length @math{n}, @code{diff (@var{x})} is the\n\
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7869 vector of first differences\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7870 @tex\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7871 $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	7872 @end tex\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7873 @ifnottex\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7874 @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	7875 @end ifnottex\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7876 \n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7877 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	7878 differences along the first non-singleton dimension.\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7879 \n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7880 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	7881 @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	7882 @var{k}-th differences. It is possible that @var{k} is larger than\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	7883 the first non-singleton dimension of the matrix. In this case,\n\
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7884 @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	7885 non-singleton dimension.\n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7886 \n\
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7887 The dimension along which to take the difference can be explicitly\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	7888 stated with the optional variable @var{dim}. In this case the\n\
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7889 @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	7890 In the case where @var{k} exceeds @code{size (@var{x}, @var{dim})}\n\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	7891 an empty matrix is returned.\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	7892 @seealso{sort, merge}\n\
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7893 @end deftypefn")
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7894 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7895 int nargin = args.length ();
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7896 octave_value retval;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7897
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7898 if (nargin < 1 \|\| nargin > 3)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7899 print_usage ();
10880 92c3e8068f28 allow diff(logical) Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	7900 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	7901 error ("diff: X must be numeric or logical");
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7902
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7903 if (! error_state)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7904 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7905 int dim = -1;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7906 octave_idx_type order = 1;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7907 if (nargin > 1)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7908 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7909 if (args(1).is_scalar_type ())
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7910 order = args(1).idx_type_value (true, false);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7911 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	7912 error ("order K must be a scalar or []");
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7913 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	7914 error ("order K must be non-negative");
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7915 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7916
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7917 if (nargin > 2)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7918 {
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7919 dim = args(2).int_value (true, false);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7920 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	7921 error ("DIM must be a valid dimension");
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7922 else
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7923 dim -= 1;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7924 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7925
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7926 if (! error_state)
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7927 retval = do_diff (args(0), order, dim);
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7928 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7929
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7930 return retval;
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7931 }
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7932
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7933 /*
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7934 %!assert (diff ([1, 2, 3, 4]), [1, 1, 1])
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7935 %!assert (diff ([1, 3, 7, 19], 2), [2, 8])
9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7936 %!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	7937 %!assert (diff ([1, 2; 5, 4; 8, 7; 9, 6; 3, 1], 3), [-1, -5; -5, 0])
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7938 %!assert (isempty (diff (1)))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7939
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7940 %!error diff ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7941 %!error diff (1, 2, 3, 4)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7942 %!error diff ("foo")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	7943 %!error diff ([1, 2; 3, 4], -1)
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 9505 diff changeset	7944 */
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7945
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7946 template <class T>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	7947 static Array<T>
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7948 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	7949 {
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7950 Array<T> retval;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7951
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7952 assert (rep.ndims () == 2 && rep.rows () == 2);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7953
18099 6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	7954 octave_idx_type n = rep.columns ();
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17915 diff changeset	7955 octave_idx_type l = 0;
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7956 for (octave_idx_type i = 0; i < n; i++)
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7957 {
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7958 octave_idx_type k = rep(1, i);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7959 if (k < 0)
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7960 {
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	7961 error ("repelems: second row must contain non-negative numbers");
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7962 return retval;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7963 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7964
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7965 l += k;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7966 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7967
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7968 retval.clear (1, l);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7969 T *dest = retval.fortran_vec ();
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7970 l = 0;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7971 for (octave_idx_type i = 0; i < n; i++)
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7972 {
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7973 octave_idx_type k = rep(1, i);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7974 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	7975 dest += k;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7976 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7977
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7978 return retval;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7979 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7980
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7981 DEFUN (repelems, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	7982 "-- texinfo --\n\
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7983 @deftypefn {Built-in Function} {} repelems (@var{x}, @var{r})\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7984 Construct a vector of repeated elements from @var{x}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7985 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7986 @var{r} is a 2x@var{N} integer matrix specifying which elements to repeat and\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7987 how often to repeat each element. Entries in the first row, @var{r}(1,j),\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7988 select an element to repeat. The corresponding entry in the second row,\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7989 @var{r}(2,j), specifies the repeat count. If @var{x} is a matrix then the\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7990 columns of @var{x} are imagined to be stacked on top of each other for\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	7991 purposes of the selection index. A row vector is always returned.\n\
10801 a40e32927b3a Improve documentation for new repelems function. Rik <octave@nomad.inbox5.com> parents: 10799 diff changeset	7992 \n\
a40e32927b3a Improve documentation for new repelems function. Rik <octave@nomad.inbox5.com> parents: 10799 diff changeset	7993 Conceptually the result is calculated as follows:\n\
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7994 \n\
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	7995 @example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	7996 @group\n\
10801 a40e32927b3a Improve documentation for new repelems function. Rik <octave@nomad.inbox5.com> parents: 10799 diff changeset	7997 y = [];\n\
a40e32927b3a Improve documentation for new repelems function. Rik <octave@nomad.inbox5.com> parents: 10799 diff changeset	7998 for i = 1:columns (@var{r})\n\
a40e32927b3a Improve documentation for new repelems function. Rik <octave@nomad.inbox5.com> parents: 10799 diff changeset	7999 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	8000 endfor\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10801 diff changeset	8001 @end group\n\
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8002 @end example\n\
15028 397f0d80bd47 Added many seealso to the help messages Doug Stewart <doug.dastew@gmail.com> parents: 15024 diff changeset	8003 @seealso{repmat, cat}\n\
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8004 @end deftypefn")
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8005 {
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8006 octave_value retval;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8007
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8008 if (args.length () == 2)
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8009 {
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8010 octave_value x = args(0);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8011
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8012 const Matrix rm = args(1).matrix_value ();
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8013 if (error_state)
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8014 return retval;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8015 else if (rm.rows () != 2 \|\| rm.ndims () != 2)
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8016 {
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	8017 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	8018 return retval;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8019 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8020 else
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8021 {
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8022 NoAlias< Array<octave_idx_type> > r (rm.dims ());
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8023
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8024 for (octave_idx_type i = 0; i < rm.numel (); i++)
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8025 {
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8026 octave_idx_type rx = rm(i);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8027 if (static_cast<double> (rx) != rm(i))
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8028 {
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	8029 error ("repelems: R must be a matrix of integers");
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8030 return retval;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8031 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8032
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8033 r(i) = rx;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8034 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8035
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8036 switch (x.builtin_type ())
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8037 {
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8038 #define BTYP_BRANCH(X, EX) \
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8039 case btyp_ ## X: \
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8040 retval = do_repelems (x.EX ## _value (), r); \
18760 5baada25d5a2 Rewrite docstring of sum() to match prod(). Rik <rik@octave.org> parents: 18759 diff changeset	8041 break;
10799 177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8042
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8043 BTYP_BRANCH (double, array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8044 BTYP_BRANCH (float, float_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8045 BTYP_BRANCH (complex, complex_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8046 BTYP_BRANCH (float_complex, float_complex_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8047 BTYP_BRANCH (bool, bool_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8048 BTYP_BRANCH (char, char_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8049
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8050 BTYP_BRANCH (int8, int8_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8051 BTYP_BRANCH (int16, int16_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8052 BTYP_BRANCH (int32, int32_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8053 BTYP_BRANCH (int64, int64_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8054 BTYP_BRANCH (uint8, uint8_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8055 BTYP_BRANCH (uint16, uint16_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8056 BTYP_BRANCH (uint32, uint32_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8057 BTYP_BRANCH (uint64, uint64_array);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8058
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8059 BTYP_BRANCH (cell, cell);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8060 //BTYP_BRANCH (struct, map);//FIXME
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8061 #undef BTYP_BRANCH
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8062
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8063 default:
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8064 gripe_wrong_type_arg ("repelems", x);
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8065 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8066 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8067 }
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8068 else
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8069 print_usage ();
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8070
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8071 return retval;
177f1ad7c7c1 new built-in: repelems Jaroslav Hajek <highegg@gmail.com> parents: 10785 diff changeset	8072 }
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8073
15252 fa0118cb67d9 move base64 encode and decode functionality to liboctave John W. Eaton <jwe@octave.org> parents: 15213 diff changeset	8074 DEFUN (base64_encode, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8075 "-- texinfo --\n\
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8076 @deftypefn {Built-in Function} {@var{s} =} base64_encode (@var{x})\n\
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8077 Encode a double matrix or array @var{x} into the base64 format string\n\
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8078 @var{s}.\n\
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8079 \n\
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8080 @seealso{base64_decode}\n\
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8081 @end deftypefn")
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8082 {
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8083 octave_value_list retval;
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8084 int nargin = args.length ();
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8085
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8086 if (nargin != 1)
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8087 print_usage ();
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8088 else
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8089 {
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8090 if (! args(0).is_numeric_type ())
15111 5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8091 error ("base64_encode: encoding is supported only for numeric arrays");
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8092 else if (args(0).is_complex_type ()
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8093 \|\| args(0).is_sparse_type ())
15111 5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8094 error ("base64_encode: encoding complex or sparse data is not supported");
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8095 else if (args(0).is_integer_type ())
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8096 {
15111 5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8097 #define MAKE_INT_BRANCH(X) \
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8098 if (args(0).is_ ## X ## _type ()) \
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8099 { \
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8100 const X##NDArray in = args(0). X## _array_value (); \
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8101 size_t inlen = \
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8102 in.numel () * sizeof (X## _t) / sizeof (char); \
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8103 const char* inc = \
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8104 reinterpret_cast<const char*> (in.data ()); \
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8105 char* out; \
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8106 if (! error_state \
17621 d41c8f96ed06 avoid memory leaks in base_64_encode and base_64_decode (bug #40228) John W. Eaton <jwe@octave.org> parents: 17281 diff changeset	8107 && octave_base64_encode (inc, inlen, &out)) \
d41c8f96ed06 avoid memory leaks in base_64_encode and base_64_decode (bug #40228) John W. Eaton <jwe@octave.org> parents: 17281 diff changeset	8108 { \
d41c8f96ed06 avoid memory leaks in base_64_encode and base_64_decode (bug #40228) John W. Eaton <jwe@octave.org> parents: 17281 diff changeset	8109 retval(0) = octave_value (out); \
d41c8f96ed06 avoid memory leaks in base_64_encode and base_64_decode (bug #40228) John W. Eaton <jwe@octave.org> parents: 17281 diff changeset	8110 ::free (out); \
d41c8f96ed06 avoid memory leaks in base_64_encode and base_64_decode (bug #40228) John W. Eaton <jwe@octave.org> parents: 17281 diff changeset	8111 } \
15111 5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8112 }
17621 d41c8f96ed06 avoid memory leaks in base_64_encode and base_64_decode (bug #40228) John W. Eaton <jwe@octave.org> parents: 17281 diff changeset	8113
15111 5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8114 MAKE_INT_BRANCH(int8)
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8115 else MAKE_INT_BRANCH(int16)
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8116 else MAKE_INT_BRANCH(int32)
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8117 else MAKE_INT_BRANCH(int64)
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8118 else MAKE_INT_BRANCH(uint8)
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8119 else MAKE_INT_BRANCH(uint16)
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8120 else MAKE_INT_BRANCH(uint32)
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8121 else MAKE_INT_BRANCH(uint64)
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8122 #undef MAKE_INT_BRANCH
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8123
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8124 else
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8125 panic_impossible ();
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8126 }
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8127 else if (args(0).is_single_type ())
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8128 {
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8129 const Array<float> in = args(0).float_array_value ();
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8130 size_t inlen;
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8131 inlen = in.numel () * sizeof (float) / sizeof (char);
15111 5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8132 const char* inc;
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8133 inc = reinterpret_cast<const char*> (in.data ());
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8134 char* out;
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8135 if (! error_state
15252 fa0118cb67d9 move base64 encode and decode functionality to liboctave John W. Eaton <jwe@octave.org> parents: 15213 diff changeset	8136 && octave_base64_encode (inc, inlen, &out))
17621 d41c8f96ed06 avoid memory leaks in base_64_encode and base_64_decode (bug #40228) John W. Eaton <jwe@octave.org> parents: 17281 diff changeset	8137 {
d41c8f96ed06 avoid memory leaks in base_64_encode and base_64_decode (bug #40228) John W. Eaton <jwe@octave.org> parents: 17281 diff changeset	8138 retval(0) = octave_value (out);
d41c8f96ed06 avoid memory leaks in base_64_encode and base_64_decode (bug #40228) John W. Eaton <jwe@octave.org> parents: 17281 diff changeset	8139 ::free (out);
d41c8f96ed06 avoid memory leaks in base_64_encode and base_64_decode (bug #40228) John W. Eaton <jwe@octave.org> parents: 17281 diff changeset	8140 }
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8141 }
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8142 else
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8143 {
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8144 const Array<double> in = args(0).array_value ();
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8145 size_t inlen;
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8146 inlen = in.numel () * sizeof (double) / sizeof (char);
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8147 const char* inc;
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8148 inc = reinterpret_cast<const char*> (in.data ());
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8149 char* out;
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8150 if (! error_state
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8151 && octave_base64_encode (inc, inlen, &out))
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8152 {
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8153 retval(0) = octave_value (out);
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8154 ::free (out);
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8155 }
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8156 }
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8157 }
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8158 return retval;
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8159 }
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8160
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8161 /*
15111 5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8162 %!assert (base64_encode (single (pi)), "2w9JQA==")
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8163 %!assert (base64_encode (uint8 ([0 0 0])), "AAAA")
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8164 %!assert (base64_encode (uint16 ([0 0 0])), "AAAAAAAA")
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8165 %!assert (base64_encode (uint32 ([0 0 0])), "AAAAAAAAAAAAAAAA")
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8166 %!assert (base64_encode (uint64 ([0 0 0])), "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA")
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8167 %!assert (base64_encode (uint8 ([255 255 255])), "////")
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8168
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8169 %!error base64_encode ()
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8170 %!error base64_encode (1,2)
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8171 %!error base64_encode ("A string")
15111 5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8172 %!error base64_encode ({"A cell array"})
5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8173 %!error base64_encode (struct ())
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8174 */
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8175
15252 fa0118cb67d9 move base64 encode and decode functionality to liboctave John W. Eaton <jwe@octave.org> parents: 15213 diff changeset	8176 DEFUN (base64_decode, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8177 "-- texinfo --\n\
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8178 @deftypefn {Built-in Function} {@var{x} =} base64_decode (@var{s})\n\
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8179 @deftypefnx {Built-in Function} {@var{x} =} base64_decode (@var{s}, @var{dims})\n\
15252 fa0118cb67d9 move base64 encode and decode functionality to liboctave John W. Eaton <jwe@octave.org> parents: 15213 diff changeset	8180 Decode the double matrix or array @var{x} from the base64 encoded string\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	8181 @var{s}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	8182 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	8183 The optional input parameter @var{dims} should be a vector containing the\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	8184 dimensions of the decoded array.\n\
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8185 @seealso{base64_encode}\n\
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8186 @end deftypefn")
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8187 {
15252 fa0118cb67d9 move base64 encode and decode functionality to liboctave John W. Eaton <jwe@octave.org> parents: 15213 diff changeset	8188 octave_value retval;
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8189
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8190 int nargin = args.length ();
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8191
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8192 if (nargin < 1 \|\| nargin > 2)
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8193 print_usage ();
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8194 else
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8195 {
15252 fa0118cb67d9 move base64 encode and decode functionality to liboctave John W. Eaton <jwe@octave.org> parents: 15213 diff changeset	8196 dim_vector dims;
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8197
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8198 if (nargin > 1)
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8199 {
15252 fa0118cb67d9 move base64 encode and decode functionality to liboctave John W. Eaton <jwe@octave.org> parents: 15213 diff changeset	8200 const Array<octave_idx_type> size =
15111 5dd599df36de generalize base64_encode to work with data types other than double Carlo de Falco <cdf@users.sourceforge.net> parents: 15094 diff changeset	8201 args(1).octave_idx_type_vector_value ();
15252 fa0118cb67d9 move base64 encode and decode functionality to liboctave John W. Eaton <jwe@octave.org> parents: 15213 diff changeset	8202
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8203 if (! error_state)
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8204 {
20267 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20253 diff changeset	8205 dims = dim_vector::alloc (size.numel ());
a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20253 diff changeset	8206 for (octave_idx_type i = 0; i < size.numel (); i++)
15252 fa0118cb67d9 move base64 encode and decode functionality to liboctave John W. Eaton <jwe@octave.org> parents: 15213 diff changeset	8207 dims(i) = size(i);
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8208 }
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8209 }
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8210
15252 fa0118cb67d9 move base64 encode and decode functionality to liboctave John W. Eaton <jwe@octave.org> parents: 15213 diff changeset	8211 const std::string str = args(0).string_value ();
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8212
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8213 if (! error_state)
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8214 {
15252 fa0118cb67d9 move base64 encode and decode functionality to liboctave John W. Eaton <jwe@octave.org> parents: 15213 diff changeset	8215 Array<double> res = octave_base64_decode (str);
fa0118cb67d9 move base64 encode and decode functionality to liboctave John W. Eaton <jwe@octave.org> parents: 15213 diff changeset	8216
fa0118cb67d9 move base64 encode and decode functionality to liboctave John W. Eaton <jwe@octave.org> parents: 15213 diff changeset	8217 if (nargin > 1)
fa0118cb67d9 move base64 encode and decode functionality to liboctave John W. Eaton <jwe@octave.org> parents: 15213 diff changeset	8218 res = res.reshape (dims);
fa0118cb67d9 move base64 encode and decode functionality to liboctave John W. Eaton <jwe@octave.org> parents: 15213 diff changeset	8219
fa0118cb67d9 move base64 encode and decode functionality to liboctave John W. Eaton <jwe@octave.org> parents: 15213 diff changeset	8220 retval = res;
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8221 }
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8222 }
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8223
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8224 return retval;
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8225 }
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8226
abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8227 /*
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8228 %!assert (base64_decode (base64_encode (pi)), pi)
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8229 %!
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8230 %!test
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8231 %! in = randn (10);
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8232 %! outv = base64_decode (base64_encode (in));
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	8233 %! outm = base64_decode (base64_encode (in), size (in));
15052 70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8234 %! assert (outv, in(:).');
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8235 %! assert (outm, in);
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8236
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8237 %!error base64_decode ()
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8238 %!error base64_decode (1,2,3)
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8239 %!error base64_decode (1, "this is not a valid set of dimensions")
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8240 %!error <input was not valid base64> base64_decode (1)
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8241 %!error <input was not valid base64> base64_decode ("AQ=")
70a1b50bcb45 maint: Use some Octave coding conventions for base64_encode, base64_decode. Rik <rik@octave.org> parents: 15050 diff changeset	8242 %!error <incorrect input size> base64_decode ("AQ==")
15050 abc858bc5165 Add functions to encode/decode double arrays to/from base64. Carlo de Falco <cdf@users.sourceforge.net> parents: 15038 diff changeset	8243 */

Mercurial > octave-nkf

annotate libinterp/corefcn/data.cc @ 20501:16b9ec39ff46