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

annotate src/DLD-FUNCTIONS/max.cc @ 14360:97883071e8e4

doc: Correct off-by-1 spacings in all .cc docstrings * __makeinfo__.m: Only remove space at beginning of new line for docstrings from scripts/ directory where this is the convention. * besselj.cc, betainc.cc, cellfun.cc, dot.cc, fftw.cc, filter.cc, find.cc, gammainc.cc, gcd.cc, givens.cc, hex2num.cc, kron.cc, lu.cc, max.cc, qr.cc, quadcc.cc, qz.cc, regexp.cc, strfind.cc, sub2ind.cc, syl.cc, time.cc, typecast.cc, urlwrite.cc, data.cc, dirfns.cc, file-io.cc, help.cc, load-path.cc, mappers.cc, oct-parse.yy, ov-base.cc, ov-cell.cc, ov-struct.cc, ov.cc, pr-output.cc, pt-mat.cc, strfns.cc, syscalls.cc, variables.cc: Improve appearance of docstring spacing of @example code.

author	Rik <octave@nomad.inbox5.com>
date	Mon, 13 Feb 2012 07:42:56 -0800
parents	72c96de7a403
children	60e5cf354d80

rev	line source
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	1 /*
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	2
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 13915 diff changeset	3 Copyright (C) 1996-2012 John W. Eaton
8777 724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	4 Copyright (C) 2009 VZLU Prague
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	5
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	6 This file is part of Octave.
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	7
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	8 Octave is free software; you can redistribute it and/or modify it
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	9 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: 6711 diff changeset	10 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6711 diff changeset	11 option) any later version.
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	12
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	13 Octave is distributed in the hope that it will be useful, but WITHOUT
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	16 for more details.
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	17
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	18 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: 6711 diff changeset	19 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6711 diff changeset	20 <http://www.gnu.org/licenses/>.
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	21
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	22 */
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	23
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	24 #ifdef HAVE_CONFIG_H
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	25 #include <config.h>
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	26 #endif
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	27
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	28 #include "lo-ieee.h"
3248 68259f410026 [project @ 1999-07-13 03:34:54 by jwe] jwe parents: 3243 diff changeset	29 #include "lo-mappers.h"
7231 2eb392d058bb [project @ 2007-11-30 18:53:29 by jwe] jwe parents: 7189 diff changeset	30 #include "lo-math.h"
4844 9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe] jwe parents: 4522 diff changeset	31 #include "dNDArray.h"
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe] jwe parents: 4522 diff changeset	32 #include "CNDArray.h"
4153 6b96ce9f5743 [project @ 2002-11-06 20:38:49 by jwe] jwe parents: 4102 diff changeset	33 #include "quit.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	34
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	35 #include "defun-dld.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	36 #include "error.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	37 #include "gripes.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	38 #include "oct-obj.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	39
4844 9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe] jwe parents: 4522 diff changeset	40 #include "ov-cx-mat.h"
7505 f5005d9510f4 Remove dispatched sparse functions and treat in the generic versions of the functions David Bateman <dbateman@free.fr> parents: 7231 diff changeset	41 #include "ov-re-sparse.h"
f5005d9510f4 Remove dispatched sparse functions and treat in the generic versions of the functions David Bateman <dbateman@free.fr> parents: 7231 diff changeset	42 #include "ov-cx-sparse.h"
4844 9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe] jwe parents: 4522 diff changeset	43
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	44 template <class ArrayType>
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	45 static octave_value_list
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	46 do_minmax_red_op (const octave_value& arg,
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	47 int nargout, int dim, bool ismin)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	48 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	49 octave_value_list retval;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	50 ArrayType array = octave_value_extract<ArrayType> (arg);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	51
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	52 if (error_state)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	53 return retval;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	54
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	55 if (nargout == 2)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	56 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	57 retval.resize (2);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	58 Array<octave_idx_type> idx;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	59 if (ismin)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	60 retval(0) = array.min (idx, dim);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	61 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	62 retval(0) = array.max (idx, dim);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	63
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	64 retval(1) = octave_value (idx, true, true);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	65 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	66 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	67 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	68 if (ismin)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	69 retval(0) = array.min (dim);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	70 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	71 retval(0) = array.max (dim);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	72 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	73
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	74 return retval;
8777 724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	75 }
724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	76
9993 b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	77 // Specialization for bool arrays.
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	78 template <>
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	79 octave_value_list
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	80 do_minmax_red_op<boolNDArray> (const octave_value& arg,
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	81 int nargout, int dim, bool ismin)
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	82 {
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	83 octave_value_list retval;
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	84
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	85 if (nargout <= 1)
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	86 {
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	87 // This case can be handled using any/all.
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	88 boolNDArray array = arg.bool_array_value ();
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	89
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	90 if (array.is_empty ())
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	91 retval(0) = array;
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	92 else if (ismin)
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	93 retval(0) = array.all (dim);
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	94 else
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	95 retval(0) = array.any (dim);
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	96 }
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	97 else
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	98 {
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	99 // any/all don't have indexed versions, so do it via a conversion.
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	100 retval = do_minmax_red_op<int8NDArray> (arg, nargout, dim, ismin);
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	101 if (! error_state)
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	102 retval(0) = retval(0).bool_array_value ();
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	103 }
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	104
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	105 return retval;
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	106 }
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	107
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	108 template <class ArrayType>
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	109 static octave_value
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	110 do_minmax_bin_op (const octave_value& argx, const octave_value& argy,
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	111 bool ismin)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	112 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	113 typedef typename ArrayType::element_type ScalarType;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	114
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	115 octave_value retval;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	116
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	117 if (argx.is_scalar_type () == 1)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	118 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	119 ScalarType x = octave_value_extract<ScalarType> (argx);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	120 ArrayType y = octave_value_extract<ArrayType> (argy);
7189 e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7017 diff changeset	121
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	122 if (error_state)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	123 ;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	124 else if (ismin)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	125 retval = min (x, y);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	126 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	127 retval = max (x, y);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	128 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	129 else if (argy.is_scalar_type () == 1)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	130 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	131 ArrayType x = octave_value_extract<ArrayType> (argx);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	132 ScalarType y = octave_value_extract<ScalarType> (argy);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	133
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	134 if (error_state)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	135 ;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	136 else if (ismin)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	137 retval = min (x, y);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	138 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	139 retval = max (x, y);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	140 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	141 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	142 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	143 ArrayType x = octave_value_extract<ArrayType> (argx);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	144 ArrayType y = octave_value_extract<ArrayType> (argy);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	145
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	146 if (error_state)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	147 ;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	148 else if (ismin)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	149 retval = min (x, y);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	150 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	151 retval = max (x, y);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	152 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	153
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	154 return retval;
8777 724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	155 }
724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	156
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	157 static octave_value_list
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	158 do_minmax_body (const octave_value_list& args,
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	159 int nargout, bool ismin)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	160 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	161 octave_value_list retval;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	162
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	163 const char *func = ismin ? "min" : "max";
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	164
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	165 int nargin = args.length ();
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7662 diff changeset	166
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	167 if (nargin == 3 \|\| nargin == 1)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	168 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	169 octave_value arg = args(0);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	170 int dim = -1;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	171 if (nargin == 3)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	172 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	173 dim = args(2).int_value (true) - 1;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	174 if (error_state \|\| dim < 0)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	175 {
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	176 error ("%s: DIM must be a valid dimension", func);
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	177 return retval;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	178 }
8777 724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	179
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	180 if (! args(1).is_empty ())
13717 fcdf0993b8c9 Fix segfault in do_minmax_bin_op (bug #34589) Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 11586 diff changeset	181 warning ("%s: second argument is ignored", func);
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	182 }
7189 e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7017 diff changeset	183
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	184 switch (arg.builtin_type ())
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	185 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	186 case btyp_double:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	187 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	188 if (arg.is_range () && (dim == -1 \|\| dim == 1))
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	189 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	190 Range range = arg.range_value ();
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	191 if (range.nelem () == 0)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	192 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	193 retval(0) = arg;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	194 if (nargout > 1)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	195 retval(1) = arg;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	196 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	197 else if (ismin)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	198 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	199 retval(0) = range.min ();
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	200 if (nargout > 1)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	201 retval(1) = static_cast<double> (range.inc () < 0 ? range.nelem () : 1);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	202 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	203 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	204 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	205 retval(0) = range.max ();
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	206 if (nargout > 1)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	207 retval(1) = static_cast<double> (range.inc () >= 0 ? range.nelem () : 1);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	208 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	209 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	210 else if (arg.is_sparse_type ())
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	211 retval = do_minmax_red_op<SparseMatrix> (arg, nargout, dim, ismin);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	212 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	213 retval = do_minmax_red_op<NDArray> (arg, nargout, dim, ismin);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	214 break;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	215 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	216 case btyp_complex:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	217 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	218 if (arg.is_sparse_type ())
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	219 retval = do_minmax_red_op<SparseComplexMatrix> (arg, nargout, dim, ismin);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	220 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	221 retval = do_minmax_red_op<ComplexNDArray> (arg, nargout, dim, ismin);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	222 break;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	223 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	224 case btyp_float:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	225 retval = do_minmax_red_op<FloatNDArray> (arg, nargout, dim, ismin);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	226 break;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	227 case btyp_float_complex:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	228 retval = do_minmax_red_op<FloatComplexNDArray> (arg, nargout, dim, ismin);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	229 break;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	230 #define MAKE_INT_BRANCH(X) \
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	231 case btyp_ ## X: \
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	232 retval = do_minmax_red_op<X ## NDArray> (arg, nargout, dim, ismin); \
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	233 break;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	234 MAKE_INT_BRANCH (int8);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	235 MAKE_INT_BRANCH (int16);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	236 MAKE_INT_BRANCH (int32);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	237 MAKE_INT_BRANCH (int64);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	238 MAKE_INT_BRANCH (uint8);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	239 MAKE_INT_BRANCH (uint16);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	240 MAKE_INT_BRANCH (uint32);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	241 MAKE_INT_BRANCH (uint64);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	242 #undef MAKE_INT_BRANCH
9993 b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	243 case btyp_bool:
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	244 retval = do_minmax_red_op<boolNDArray> (arg, nargout, dim, ismin);
b22a2f4b34aa support min/max with logical arrays Jaroslav Hajek <highegg@gmail.com> parents: 9791 diff changeset	245 break;
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	246 default:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	247 gripe_wrong_type_arg (func, arg);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	248 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	249 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	250 else if (nargin == 2)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	251 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	252 octave_value argx = args(0), argy = args(1);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	253 builtin_type_t xtyp = argx.builtin_type (), ytyp = argy.builtin_type ();
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	254 builtin_type_t rtyp = btyp_mixed_numeric (xtyp, ytyp);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	255
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	256 switch (rtyp)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	257 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	258 case btyp_double:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	259 {
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	260 if ((argx.is_sparse_type ()
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	261 && (argy.is_sparse_type () \|\| argy.is_scalar_type ()))
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	262 \|\| (argy.is_sparse_type () && argx.is_scalar_type ()))
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	263 retval = do_minmax_bin_op<SparseMatrix> (argx, argy, ismin);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	264 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	265 retval = do_minmax_bin_op<NDArray> (argx, argy, ismin);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	266 break;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	267 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	268 case btyp_complex:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	269 {
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	270 if ((argx.is_sparse_type ()
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	271 && (argy.is_sparse_type () \|\| argy.is_scalar_type ()))
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	272 \|\| (argy.is_sparse_type () && argx.is_scalar_type ()))
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	273 retval = do_minmax_bin_op<SparseComplexMatrix> (argx, argy, ismin);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	274 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	275 retval = do_minmax_bin_op<ComplexNDArray> (argx, argy, ismin);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	276 break;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	277 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	278 case btyp_float:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	279 retval = do_minmax_bin_op<FloatNDArray> (argx, argy, ismin);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	280 break;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	281 case btyp_float_complex:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	282 retval = do_minmax_bin_op<FloatComplexNDArray> (argx, argy, ismin);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	283 break;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	284 #define MAKE_INT_BRANCH(X) \
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	285 case btyp_ ## X: \
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	286 retval = do_minmax_bin_op<X ## NDArray> (argx, argy, ismin); \
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	287 break;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	288 MAKE_INT_BRANCH (int8);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	289 MAKE_INT_BRANCH (int16);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	290 MAKE_INT_BRANCH (int32);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	291 MAKE_INT_BRANCH (int64);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	292 MAKE_INT_BRANCH (uint8);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	293 MAKE_INT_BRANCH (uint16);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	294 MAKE_INT_BRANCH (uint32);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	295 MAKE_INT_BRANCH (uint64);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	296 #undef MAKE_INT_BRANCH
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	297 default:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	298 error ("%s: cannot compute %s (%s, %s)", func, func,
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	299 argx.type_name ().c_str (), argy.type_name ().c_str ());
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	300 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	301 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	302 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	303 print_usage ();
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	304
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	305 return retval;
7505 f5005d9510f4 Remove dispatched sparse functions and treat in the generic versions of the functions David Bateman <dbateman@free.fr> parents: 7231 diff changeset	306 }
f5005d9510f4 Remove dispatched sparse functions and treat in the generic versions of the functions David Bateman <dbateman@free.fr> parents: 7231 diff changeset	307
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	308 DEFUN_DLD (min, args, nargout,
3443 bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe] jwe parents: 3418 diff changeset	309 "-- texinfo --\n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	310 @deftypefn {Loadable Function} {} min (@var{x})\n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	311 @deftypefnx {Loadable Function} {} min (@var{x}, @var{y})\n\
13789 4de1e8778d48 Fix typo in @var macro in cset 8bb7bdbe9c69. Rik <octave@nomad.inbox5.com> parents: 13786 diff changeset	312 @deftypefnx {Loadable Function} {} min (@var{x}, [], @var{dim})\n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	313 @deftypefnx {Loadable Function} {} min (@var{x}, @var{y}, @var{dim})\n\
8780 ea76466605ba support native cumsum, gripe on overflow in sum/cumsum Jaroslav Hajek <highegg@gmail.com> parents: 8778 diff changeset	314 @deftypefnx {Loadable Function} {[@var{w}, @var{iw}] =} min (@var{x})\n\
3443 bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe] jwe parents: 3418 diff changeset	315 For a vector argument, return the minimum value. For a matrix\n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe] jwe parents: 3418 diff changeset	316 argument, return the minimum value from each column, as a row\n\
13789 4de1e8778d48 Fix typo in @var macro in cset 8bb7bdbe9c69. Rik <octave@nomad.inbox5.com> parents: 13786 diff changeset	317 vector, or over the dimension @var{dim} if defined, in which case @var{y} \n\
13786 40dab5d70115 Clarify the third argument of max/min. Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 13717 diff changeset	318 should be set to the empty matrix (it's ignored otherwise). For two matrices\n\
4844 9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe] jwe parents: 4522 diff changeset	319 (or a matrix and scalar), return the pair-wise minimum.\n\
4522 abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	320 Thus,\n\
3443 bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe] jwe parents: 3418 diff changeset	321 \n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe] jwe parents: 3418 diff changeset	322 @example\n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe] jwe parents: 3418 diff changeset	323 min (min (@var{x}))\n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe] jwe parents: 3418 diff changeset	324 @end example\n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe] jwe parents: 3418 diff changeset	325 \n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe] jwe parents: 3418 diff changeset	326 @noindent\n\
4522 abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	327 returns the smallest element of @var{x}, and\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	328 \n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	329 @example\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	330 @group\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	331 min (2:5, pi)\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	332 @result{} 2.0000 3.0000 3.1416 3.1416\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	333 @end group\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	334 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10155 diff changeset	335 \n\
4522 abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	336 @noindent\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	337 compares each element of the range @code{2:5} with @code{pi}, and\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	338 returns a row vector of the minimum values.\n\
3443 bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe] jwe parents: 3418 diff changeset	339 \n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe] jwe parents: 3418 diff changeset	340 For complex arguments, the magnitude of the elements are used for\n\
3657 a908150a3a32 [project @ 2000-04-11 19:02:03 by jwe] jwe parents: 3443 diff changeset	341 comparison.\n\
a908150a3a32 [project @ 2000-04-11 19:02:03 by jwe] jwe parents: 3443 diff changeset	342 \n\
4522 abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	343 If called with one input and two output arguments,\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	344 @code{min} also returns the first index of the\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8949 diff changeset	345 minimum value(s). Thus,\n\
4522 abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	346 \n\
3775 13905c3a24af [project @ 2001-02-06 01:56:59 by jwe] jwe parents: 3747 diff changeset	347 @example\n\
4522 abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	348 @group\n\
9165 8c71a86c4bf4 Update section 17.5 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9141 diff changeset	349 [x, ix] = min ([1, 3, 0, 2, 0])\n\
4522 abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	350 @result{} x = 0\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	351 ix = 3\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	352 @end group\n\
3657 a908150a3a32 [project @ 2000-04-11 19:02:03 by jwe] jwe parents: 3443 diff changeset	353 @end example\n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	354 @seealso{max, cummin, cummax}\n\
4522 abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	355 @end deftypefn")
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	356 {
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	357 return do_minmax_body (args, nargout, true);
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	358 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	359
7600 24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	360 /*
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	361
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	362 %% test/octave.test/arith/min-1.m
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	363 %!assert (min ([1, 4, 2, 3]) == 1);
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	364 %!assert (min ([1; -10; 5; -2]) == -10);
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	365
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	366 %% test/octave.test/arith/min-2.m
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	367 %!assert(all (min ([4, i; -2, 2]) == [-2, i]));
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	368
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	369 %% test/octave.test/arith/min-3.m
13915 5fa482628bf6 Remove unnecessary regular expression '.' from ends of %!error blocks Rik <octave@nomad.inbox5.com>* parents: 13789 diff changeset	370 %!error <Invalid call to min> min ();
7600 24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	371
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	372 %% test/octave.test/arith/min-4.m
13915 5fa482628bf6 Remove unnecessary regular expression '.' from ends of %!error blocks Rik <octave@nomad.inbox5.com>* parents: 13789 diff changeset	373 %!error <Invalid call to min> min (1, 2, 3, 4);
7600 24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	374
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	375 %!test
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	376 %! x = reshape (1:8,[2,2,2]);
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	377 %! assert (max (x,[],1), reshape ([2, 4, 6, 8], [1,2,2]));
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	378 %! assert (max (x,[],2), reshape ([3, 4, 7, 8], [2,1,2]));
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	379 %! [y, i ] = max (x, [], 3);
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	380 %! assert (y, [5, 7; 6, 8]);
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	381 %! assert (ndims(y), 2);
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	382 %! assert (i, [2, 2; 2, 2]);
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	383 %! assert (ndims(i), 2);
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	384
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	385 */
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	386
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	387 DEFUN_DLD (max, args, nargout,
3443 bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe] jwe parents: 3418 diff changeset	388 "-- texinfo --\n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	389 @deftypefn {Loadable Function} {} max (@var{x})\n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	390 @deftypefnx {Loadable Function} {} max (@var{x}, @var{y})\n\
13789 4de1e8778d48 Fix typo in @var macro in cset 8bb7bdbe9c69. Rik <octave@nomad.inbox5.com> parents: 13786 diff changeset	391 @deftypefnx {Loadable Function} {} max (@var{x}, [], @var{dim})\n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	392 @deftypefnx {Loadable Function} {} max (@var{x}, @var{y}, @var{dim})\n\
8780 ea76466605ba support native cumsum, gripe on overflow in sum/cumsum Jaroslav Hajek <highegg@gmail.com> parents: 8778 diff changeset	393 @deftypefnx {Loadable Function} {[@var{w}, @var{iw}] =} max (@var{x})\n\
3443 bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe] jwe parents: 3418 diff changeset	394 For a vector argument, return the maximum value. For a matrix\n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe] jwe parents: 3418 diff changeset	395 argument, return the maximum value from each column, as a row\n\
13789 4de1e8778d48 Fix typo in @var macro in cset 8bb7bdbe9c69. Rik <octave@nomad.inbox5.com> parents: 13786 diff changeset	396 vector, or over the dimension @var{dim} if defined, in which case @var{y} \n\
13786 40dab5d70115 Clarify the third argument of max/min. Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 13717 diff changeset	397 should be set to the empty matrix (it's ignored otherwise). For two matrices\n\
4844 9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe] jwe parents: 4522 diff changeset	398 (or a matrix and scalar), return the pair-wise maximum.\n\
4522 abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	399 Thus,\n\
3443 bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe] jwe parents: 3418 diff changeset	400 \n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe] jwe parents: 3418 diff changeset	401 @example\n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe] jwe parents: 3418 diff changeset	402 max (max (@var{x}))\n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe] jwe parents: 3418 diff changeset	403 @end example\n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe] jwe parents: 3418 diff changeset	404 \n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe] jwe parents: 3418 diff changeset	405 @noindent\n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	406 returns the largest element of the matrix @var{x}, and\n\
4522 abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	407 \n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	408 @example\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	409 @group\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	410 max (2:5, pi)\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	411 @result{} 3.1416 3.1416 4.0000 5.0000\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	412 @end group\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	413 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10155 diff changeset	414 \n\
4522 abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	415 @noindent\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	416 compares each element of the range @code{2:5} with @code{pi}, and\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	417 returns a row vector of the maximum values.\n\
3443 bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe] jwe parents: 3418 diff changeset	418 \n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe] jwe parents: 3418 diff changeset	419 For complex arguments, the magnitude of the elements are used for\n\
3775 13905c3a24af [project @ 2001-02-06 01:56:59 by jwe] jwe parents: 3747 diff changeset	420 comparison.\n\
3657 a908150a3a32 [project @ 2000-04-11 19:02:03 by jwe] jwe parents: 3443 diff changeset	421 \n\
4522 abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	422 If called with one input and two output arguments,\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	423 @code{max} also returns the first index of the\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8949 diff changeset	424 maximum value(s). Thus,\n\
4522 abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	425 \n\
3775 13905c3a24af [project @ 2001-02-06 01:56:59 by jwe] jwe parents: 3747 diff changeset	426 @example\n\
4522 abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	427 @group\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	428 [x, ix] = max ([1, 3, 5, 2, 5])\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	429 @result{} x = 5\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	430 ix = 3\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	431 @end group\n\
3657 a908150a3a32 [project @ 2000-04-11 19:02:03 by jwe] jwe parents: 3443 diff changeset	432 @end example\n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	433 @seealso{min, cummax, cummin}\n\
4522 abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe] jwe parents: 4309 diff changeset	434 @end deftypefn")
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	435 {
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	436 return do_minmax_body (args, nargout, false);
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	437 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	438
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	439 /*
7600 24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	440
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	441 %% test/octave.test/arith/max-1.m
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	442 %!assert (max ([1, 4, 2, 3]) == 4);
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	443 %!assert (max ([1; -10; 5; -2]) == 5);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	444
7600 24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	445 %% test/octave.test/arith/max-2.m
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	446 %!assert(all (max ([4, i 4.999; -2, 2, 3+4i]) == [4, 2, 3+4i]));
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	447
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	448 %% test/octave.test/arith/max-3.m
13915 5fa482628bf6 Remove unnecessary regular expression '.' from ends of %!error blocks Rik <octave@nomad.inbox5.com>* parents: 13789 diff changeset	449 %!error <Invalid call to max> max ();
7600 24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	450
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	451 %% test/octave.test/arith/max-4.m
13915 5fa482628bf6 Remove unnecessary regular expression '.' from ends of %!error blocks Rik <octave@nomad.inbox5.com>* parents: 13789 diff changeset	452 %!error <Invalid call to max> max (1, 2, 3, 4);
7600 24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	453
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	454 %!test
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	455 %! x = reshape (1:8,[2,2,2]);
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	456 %! assert (min (x,[],1), reshape ([1, 3, 5, 7], [1,2,2]));
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	457 %! assert (min (x,[],2), reshape ([1, 2, 5, 6], [2,1,2]));
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	458 %! [y, i ] = min (x, [], 3);
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	459 %! assert (y, [1, 3; 2, 4]);
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	460 %! assert (ndims(y), 2);
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	461 %! assert (i, [1, 1; 1, 1]);
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	462 %! assert (ndims(i), 2);
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	463
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	464
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	465 */
24abf5a702d9 Chop trailing singletons in min/max functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	466
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	467 template <class ArrayType>
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	468 static octave_value_list
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	469 do_cumminmax_red_op (const octave_value& arg,
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	470 int nargout, int dim, bool ismin)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	471 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	472 octave_value_list retval;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	473 ArrayType array = octave_value_extract<ArrayType> (arg);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	474
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	475 if (error_state)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	476 return retval;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	477
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	478 if (nargout == 2)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	479 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	480 retval.resize (2);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	481 Array<octave_idx_type> idx;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	482 if (ismin)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	483 retval(0) = array.cummin (idx, dim);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	484 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	485 retval(0) = array.cummax (idx, dim);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	486
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	487 retval(1) = octave_value (idx, true, true);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	488 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	489 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	490 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	491 if (ismin)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	492 retval(0) = array.cummin (dim);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	493 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	494 retval(0) = array.cummax (dim);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	495 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	496
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	497 return retval;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	498 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	499
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	500 static octave_value_list
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	501 do_cumminmax_body (const octave_value_list& args,
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	502 int nargout, bool ismin)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	503 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	504 octave_value_list retval;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	505
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	506 const char *func = ismin ? "cummin" : "cummax";
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	507
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	508 int nargin = args.length ();
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	509
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	510 if (nargin == 1 \|\| nargin == 2)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	511 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	512 octave_value arg = args(0);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	513 int dim = -1;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	514 if (nargin == 2)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	515 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	516 dim = args(1).int_value (true) - 1;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	517 if (error_state \|\| dim < 0)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	518 {
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	519 error ("%s: DIM must be a valid dimension", func);
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	520 return retval;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	521 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	522 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	523
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	524 switch (arg.builtin_type ())
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	525 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	526 case btyp_double:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	527 retval = do_cumminmax_red_op<NDArray> (arg, nargout, dim, ismin);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	528 break;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	529 case btyp_complex:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	530 retval = do_cumminmax_red_op<ComplexNDArray> (arg, nargout, dim, ismin);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	531 break;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	532 case btyp_float:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	533 retval = do_cumminmax_red_op<FloatNDArray> (arg, nargout, dim, ismin);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	534 break;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	535 case btyp_float_complex:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	536 retval = do_cumminmax_red_op<FloatComplexNDArray> (arg, nargout, dim, ismin);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	537 break;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	538 #define MAKE_INT_BRANCH(X) \
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	539 case btyp_ ## X: \
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	540 retval = do_cumminmax_red_op<X ## NDArray> (arg, nargout, dim, ismin); \
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	541 break;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	542 MAKE_INT_BRANCH (int8);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	543 MAKE_INT_BRANCH (int16);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	544 MAKE_INT_BRANCH (int32);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	545 MAKE_INT_BRANCH (int64);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	546 MAKE_INT_BRANCH (uint8);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	547 MAKE_INT_BRANCH (uint16);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	548 MAKE_INT_BRANCH (uint32);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	549 MAKE_INT_BRANCH (uint64);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	550 #undef MAKE_INT_BRANCH
10017 1ce1ae448572 support cummin/cummax for bools Jaroslav Hajek <highegg@gmail.com> parents: 9993 diff changeset	551 case btyp_bool:
1ce1ae448572 support cummin/cummax for bools Jaroslav Hajek <highegg@gmail.com> parents: 9993 diff changeset	552 {
1ce1ae448572 support cummin/cummax for bools Jaroslav Hajek <highegg@gmail.com> parents: 9993 diff changeset	553 retval = do_cumminmax_red_op<int8NDArray> (arg, nargout, dim, ismin);
1ce1ae448572 support cummin/cummax for bools Jaroslav Hajek <highegg@gmail.com> parents: 9993 diff changeset	554 if (retval.length () > 0)
1ce1ae448572 support cummin/cummax for bools Jaroslav Hajek <highegg@gmail.com> parents: 9993 diff changeset	555 retval(0) = retval(0).bool_array_value ();
1ce1ae448572 support cummin/cummax for bools Jaroslav Hajek <highegg@gmail.com> parents: 9993 diff changeset	556 break;
1ce1ae448572 support cummin/cummax for bools Jaroslav Hajek <highegg@gmail.com> parents: 9993 diff changeset	557 }
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	558 default:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	559 gripe_wrong_type_arg (func, arg);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	560 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	561 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	562 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	563 print_usage ();
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	564
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	565 return retval;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	566 }
8777 724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	567
724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	568 DEFUN_DLD (cummin, args, nargout,
724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	569 "-- texinfo --\n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	570 @deftypefn {Loadable Function} {} cummin (@var{x})\n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	571 @deftypefnx {Loadable Function} {} cummin (@var{x}, @var{dim})\n\
8780 ea76466605ba support native cumsum, gripe on overflow in sum/cumsum Jaroslav Hajek <highegg@gmail.com> parents: 8778 diff changeset	572 @deftypefnx {Loadable Function} {[@var{w}, @var{iw}] =} cummin (@var{x})\n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	573 Return the cumulative minimum values along dimension @var{dim}. If @var{dim}\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10155 diff changeset	574 is unspecified it defaults to column-wise operation. For example:\n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	575 \n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	576 @example\n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	577 @group\n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	578 cummin ([5 4 6 2 3 1])\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	579 @result{} 5 4 4 2 2 1\n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	580 @end group\n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	581 @end example\n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	582 \n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	583 \n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	584 The call\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10155 diff changeset	585 \n\
8777 724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	586 @example\n\
9791 6e425f6be618 simplify cummin, cummax docs Jaroslav Hajek <highegg@gmail.com> parents: 9790 diff changeset	587 [w, iw] = cummin (x)\n\
8777 724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	588 @end example\n\
724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	589 \n\
724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	590 @noindent\n\
9791 6e425f6be618 simplify cummin, cummax docs Jaroslav Hajek <highegg@gmail.com> parents: 9790 diff changeset	591 with @code{x} a vector, is equivalent to the following code:\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10155 diff changeset	592 \n\
8777 724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	593 @example\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8949 diff changeset	594 @group\n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	595 w = iw = zeros (size (x));\n\
9791 6e425f6be618 simplify cummin, cummax docs Jaroslav Hajek <highegg@gmail.com> parents: 9790 diff changeset	596 for i = 1:length (x)\n\
6e425f6be618 simplify cummin, cummax docs Jaroslav Hajek <highegg@gmail.com> parents: 9790 diff changeset	597 [w(i), iw(i)] = max (x(1:i));\n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	598 endfor\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8949 diff changeset	599 @end group\n\
8777 724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	600 @end example\n\
724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	601 \n\
724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	602 @noindent\n\
724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	603 but computed in a much faster manner.\n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	604 @seealso{cummax, min, max}\n\
8777 724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	605 @end deftypefn")
724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	606 {
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	607 return do_cumminmax_body (args, nargout, true);
8777 724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	608 }
724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	609
724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	610 DEFUN_DLD (cummax, args, nargout,
724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	611 "-- texinfo --\n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	612 @deftypefn {Loadable Function} {} cummax (@var{x})\n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	613 @deftypefnx {Loadable Function} {} cummax (@var{x}, @var{dim})\n\
8780 ea76466605ba support native cumsum, gripe on overflow in sum/cumsum Jaroslav Hajek <highegg@gmail.com> parents: 8778 diff changeset	614 @deftypefnx {Loadable Function} {[@var{w}, @var{iw}] =} cummax (@var{x})\n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	615 Return the cumulative maximum values along dimension @var{dim}. If @var{dim}\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10155 diff changeset	616 is unspecified it defaults to column-wise operation. For example:\n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	617 \n\
8777 724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	618 @example\n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	619 @group\n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	620 cummax ([1 3 2 6 4 5])\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	621 @result{} 1 3 3 6 6 6\n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	622 @end group\n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	623 @end example\n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	624 \n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	625 The call\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10155 diff changeset	626 \n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	627 @example\n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	628 [w, iw] = cummax (x, dim)\n\
8777 724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	629 @end example\n\
724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	630 \n\
724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	631 @noindent\n\
9791 6e425f6be618 simplify cummin, cummax docs Jaroslav Hajek <highegg@gmail.com> parents: 9790 diff changeset	632 with @code{x} a vector, is equivalent to the following code:\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10155 diff changeset	633 \n\
8777 724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	634 @example\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8949 diff changeset	635 @group\n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	636 w = iw = zeros (size (x));\n\
9791 6e425f6be618 simplify cummin, cummax docs Jaroslav Hajek <highegg@gmail.com> parents: 9790 diff changeset	637 for i = 1:length (x)\n\
6e425f6be618 simplify cummin, cummax docs Jaroslav Hajek <highegg@gmail.com> parents: 9790 diff changeset	638 [w(i), iw(i)] = max (x(1:i));\n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	639 endfor\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8949 diff changeset	640 @end group\n\
8777 724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	641 @end example\n\
724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	642 \n\
724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	643 @noindent\n\
724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	644 but computed in a much faster manner.\n\
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 9086 diff changeset	645 @seealso{cummin, max, min}\n\
8777 724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	646 @end deftypefn")
724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	647 {
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	648 return do_cumminmax_body (args, nargout, false);
8777 724c0f46d9d4 implement cummin/cummax functions Jaroslav Hajek <highegg@gmail.com> parents: 7919 diff changeset	649 }

Mercurial > hg > octave-nkf

annotate src/DLD-FUNCTIONS/max.cc @ 14360:97883071e8e4