annotate libinterp/corefcn/max.cc @ 20802:8bb38ba1bad6

eliminate return statements after calls to print_usage * __contourc__.cc, __dispatch__.cc, __dsearchn__.cc, __ichol__.cc, __lin_interpn__.cc, __qp__.cc, balance.cc, betainc.cc, bsxfun.cc, colloc.cc, daspk.cc, dasrt.cc, dassl.cc, defaults.cc, det.cc, dlmread.cc, dot.cc, eig.cc, ellipj.cc, fft.cc, fft2.cc, fftn.cc, filter.cc, find.cc, gcd.cc, givens.cc, hex2num.cc, inv.cc, lookup.cc, lu.cc, max.cc, mgorth.cc, ordschur.cc, pinv.cc, profiler.cc, quad.cc, qz.cc, rcond.cc, schur.cc, str2double.cc: Eliminate return statements after calls to print_usage.
author John W. Eaton <jwe@octave.org>
date Fri, 04 Dec 2015 12:03:44 -0500
parents b6408331bfa2
children 35241c4b696c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
19697
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19591
diff changeset
3 Copyright (C) 1996-2015 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
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14501
diff changeset
35 #include "defun.h"
2928
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 (nargout == 2)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
53 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
54 retval.resize (2);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
55 Array<octave_idx_type> idx;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
56 if (ismin)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
57 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
58 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
59 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
60
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
61 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
62 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
63 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
64 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
65 if (ismin)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
66 retval(0) = array.min (dim);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
67 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
68 retval(0) = array.max (dim);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
69 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
70
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
71 return retval;
8777
724c0f46d9d4 implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents: 7919
diff changeset
72 }
724c0f46d9d4 implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents: 7919
diff changeset
73
16370
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
74 // Matlab returns double arrays for min/max operations on character
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
75 // arrays, so we specialize here to get that behavior. Other possible
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
76 // solutions are to convert the argument to double here and call the
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
77 // code for double, but that could waste memory, or to have the
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
78 // underlying charNDArray::min/max functions return NDArray instead of
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
79 // charNDArray, but that is inconsistent with the way other min/max
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
80 // functions work.
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
81
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
82 template <>
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
83 octave_value_list
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
84 do_minmax_red_op<charNDArray> (const octave_value& arg,
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
85 int nargout, int dim, bool ismin)
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
86 {
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
87 octave_value_list retval;
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
88 charNDArray array = octave_value_extract<charNDArray> (arg);
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
89
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
90 if (nargout == 2)
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
91 {
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
92 retval.resize (2);
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
93 Array<octave_idx_type> idx;
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
94 if (ismin)
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
95 retval(0) = NDArray (array.min (idx, dim));
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
96 else
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
97 retval(0) = NDArray (array.max (idx, dim));
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
98
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
99 retval(1) = octave_value (idx, true, true);
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
100 }
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
101 else
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
102 {
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
103 if (ismin)
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
104 retval(0) = NDArray (array.min (dim));
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
105 else
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
106 retval(0) = NDArray (array.max (dim));
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
107 }
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
108
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
109 return retval;
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
110 }
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
111
9993
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
112 // Specialization for bool arrays.
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
113 template <>
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
114 octave_value_list
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
115 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
116 int nargout, int dim, bool ismin)
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
117 {
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
118 octave_value_list retval;
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
119
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
120 if (nargout <= 1)
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
121 {
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
122 // This case can be handled using any/all.
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
123 boolNDArray array = arg.bool_array_value ();
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
124
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
125 if (array.is_empty ())
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
126 retval(0) = array;
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
127 else if (ismin)
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
128 retval(0) = array.all (dim);
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
129 else
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
130 retval(0) = array.any (dim);
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
131 }
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
132 else
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
133 {
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
134 // 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
135 retval = do_minmax_red_op<int8NDArray> (arg, nargout, dim, ismin);
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20228
diff changeset
136
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20228
diff changeset
137 retval(0) = retval(0).bool_array_value ();
9993
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
138 }
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
139
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
140 return retval;
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
141 }
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
142
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
143 template <class ArrayType>
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
144 static octave_value
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
145 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
146 bool ismin)
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 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
149
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
150 octave_value retval;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
151
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
152 if (argx.is_scalar_type ())
9790
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 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
155 ArrayType y = octave_value_extract<ArrayType> (argy);
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7017
diff changeset
156
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20228
diff changeset
157 if (ismin)
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
158 retval = min (x, y);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
159 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
160 retval = max (x, y);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
161 }
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
162 else if (argy.is_scalar_type ())
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
163 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
164 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
165 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
166
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20228
diff changeset
167 if (ismin)
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
168 retval = min (x, y);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
169 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
170 retval = max (x, y);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
171 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
172 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
173 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
174 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
175 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
176
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20228
diff changeset
177 if (ismin)
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
178 retval = min (x, y);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
179 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
180 retval = max (x, y);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
181 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
182
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
183 return retval;
8777
724c0f46d9d4 implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents: 7919
diff changeset
184 }
724c0f46d9d4 implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents: 7919
diff changeset
185
16370
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
186 // Matlab returns double arrays for min/max operations on character
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
187 // arrays, so we specialize here to get that behavior. Other possible
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
188 // solutions are to convert the arguments to double here and call the
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
189 // code for double, but that could waste a lot of memory, or to have the
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
190 // underlying charNDArray::min/max functions return NDArray instead of
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
191 // charNDArray, but that is inconsistent with the way other min/max
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
192 // functions work.
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
193
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
194 template <>
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
195 octave_value
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
196 do_minmax_bin_op<charNDArray> (const octave_value& argx,
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
197 const octave_value& argy, bool ismin)
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
198 {
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
199 octave_value retval;
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
200
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
201 charNDArray x = octave_value_extract<charNDArray> (argx);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
202 charNDArray y = octave_value_extract<charNDArray> (argy);
16370
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
203
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20228
diff changeset
204 if (ismin)
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
205 {
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
206 if (x.numel () == 1)
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
207 retval = NDArray (min (x(0), y));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
208 else if (y.numel () == 1)
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
209 retval = NDArray (min (x, y(0)));
16370
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
210 else
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
211 retval = NDArray (min (x, y));
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
212 }
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
213 else
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
214 {
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
215 if (x.numel () == 1)
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
216 retval = NDArray (max (x(0), y));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
217 else if (y.numel () == 1)
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
218 retval = NDArray (max (x, y(0)));
16370
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
219 else
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
220 retval = NDArray (max (x, y));
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
221 }
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
222
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
223 return retval;
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
224 }
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
225
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
226 static octave_value_list
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
227 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
228 int nargout, bool ismin)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
229 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
230 octave_value_list retval;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
231
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
232 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
233
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
234 int nargin = args.length ();
7789
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents: 7662
diff changeset
235
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
236 if (nargin < 1 || nargin > 3)
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
237 print_usage ();
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
238
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
239 if (nargin == 3 || nargin == 1)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
240 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
241 octave_value arg = args(0);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
242 int dim = -1;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
243 if (nargin == 3)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
244 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
245 dim = args(2).int_value (true) - 1;
20743
b6408331bfa2 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20555
diff changeset
246
b6408331bfa2 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20555
diff changeset
247 if (dim < 0)
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
248 {
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
249 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
250 return retval;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
251 }
8777
724c0f46d9d4 implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents: 7919
diff changeset
252
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
253 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
254 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
255 }
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7017
diff changeset
256
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
257 switch (arg.builtin_type ())
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
258 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
259 case btyp_double:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
260 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
261 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
262 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
263 Range range = arg.range_value ();
20228
00cf2847355d Deprecate Array::nelem() and Range::nelem() in favour of ::numel().
Carnë Draug <carandraug@octave.org>
parents: 20172
diff changeset
264 if (range.numel () < 1)
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
265 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
266 retval(0) = arg;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
267 if (nargout > 1)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
268 retval(1) = arg;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
269 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
270 else if (ismin)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
271 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
272 retval(0) = range.min ();
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
273 if (nargout > 1)
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
274 retval(1) = static_cast<double>
20228
00cf2847355d Deprecate Array::nelem() and Range::nelem() in favour of ::numel().
Carnë Draug <carandraug@octave.org>
parents: 20172
diff changeset
275 (range.inc () < 0 ? range.numel () : 1);
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
276 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
277 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
278 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
279 retval(0) = range.max ();
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
280 if (nargout > 1)
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
281 retval(1) = static_cast<double>
20228
00cf2847355d Deprecate Array::nelem() and Range::nelem() in favour of ::numel().
Carnë Draug <carandraug@octave.org>
parents: 20172
diff changeset
282 (range.inc () >= 0 ? range.numel () : 1);
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
283 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
284 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
285 else if (arg.is_sparse_type ())
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
286 retval = do_minmax_red_op<SparseMatrix> (arg, nargout, dim,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
287 ismin);
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
288 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
289 retval = do_minmax_red_op<NDArray> (arg, nargout, dim, ismin);
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
290
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
291 }
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
292 break;
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
293
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
294 case btyp_complex:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
295 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
296 if (arg.is_sparse_type ())
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
297 retval = do_minmax_red_op<SparseComplexMatrix> (arg, nargout, dim,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
298 ismin);
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
299 else
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
300 retval = do_minmax_red_op<ComplexNDArray> (arg, nargout, dim,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
301 ismin);
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
302 }
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
303 break;
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
304
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
305 case btyp_float:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
306 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
307 break;
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
308
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
309 case btyp_float_complex:
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
310 retval = do_minmax_red_op<FloatComplexNDArray> (arg, nargout, dim,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
311 ismin);
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
312 break;
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
313
16370
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
314 case btyp_char:
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
315 retval = do_minmax_red_op<charNDArray> (arg, nargout, dim, ismin);
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
316 break;
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
317
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
318 #define MAKE_INT_BRANCH(X) \
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
319 case btyp_ ## X: \
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
320 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
321 break;
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
322
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
323 MAKE_INT_BRANCH (int8);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
324 MAKE_INT_BRANCH (int16);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
325 MAKE_INT_BRANCH (int32);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
326 MAKE_INT_BRANCH (int64);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
327 MAKE_INT_BRANCH (uint8);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
328 MAKE_INT_BRANCH (uint16);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
329 MAKE_INT_BRANCH (uint32);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
330 MAKE_INT_BRANCH (uint64);
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
331
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
332 #undef MAKE_INT_BRANCH
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
333
9993
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
334 case btyp_bool:
b22a2f4b34aa support min/max with logical arrays
Jaroslav Hajek <highegg@gmail.com>
parents: 9791
diff changeset
335 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
336 break;
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
337
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
338 default:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
339 gripe_wrong_type_arg (func, arg);
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
340 }
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
341 }
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
342 else
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
343 {
18100
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp.
Rik <rik@octave.org>
parents: 18076
diff changeset
344 octave_value argx = args(0);
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp.
Rik <rik@octave.org>
parents: 18076
diff changeset
345 octave_value argy = args(1);
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp.
Rik <rik@octave.org>
parents: 18076
diff changeset
346 builtin_type_t xtyp = argx.builtin_type ();
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp.
Rik <rik@octave.org>
parents: 18076
diff changeset
347 builtin_type_t ytyp = argy.builtin_type ();
16370
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
348 builtin_type_t rtyp;
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
349 if (xtyp == btyp_char && ytyp == btyp_char)
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
350 rtyp = btyp_char;
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
351 /*
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
352 FIXME: This is what should happen when boolNDArray has max()
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
353 else if (xtyp == btyp_bool && ytyp == btyp_bool)
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
354 rtyp = btyp_bool;
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
355 */
16370
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
356 else
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
357 rtyp = btyp_mixed_numeric (xtyp, ytyp);
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
358
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
359 switch (rtyp)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
360 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
361 case btyp_double:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
362 {
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
363 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
364 && (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
365 || (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
366 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
367 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
368 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
369 }
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
370 break;
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
371
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
372 case btyp_complex:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
373 {
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
374 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
375 && (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
376 || (argy.is_sparse_type () && argx.is_scalar_type ()))
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
377 retval = do_minmax_bin_op<SparseComplexMatrix> (argx, argy,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
378 ismin);
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
379 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
380 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
381 }
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
382 break;
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
383
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
384 case btyp_float:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
385 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
386 break;
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
387
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
388 case btyp_float_complex:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
389 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
390 break;
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
391
16370
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
392 case btyp_char:
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
393 retval = do_minmax_bin_op<charNDArray> (argx, argy, ismin);
7ce21619a4b9 min Matlab compatibility issue (bug #33530)
Axel Mathéi <axel.mathei@gmail.com>
parents: 15195
diff changeset
394 break;
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
395
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
396 #define MAKE_INT_BRANCH(X) \
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
397 case btyp_ ## X: \
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
398 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
399 break;
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
400
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
401 MAKE_INT_BRANCH (int8);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
402 MAKE_INT_BRANCH (int16);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
403 MAKE_INT_BRANCH (int32);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
404 MAKE_INT_BRANCH (int64);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
405 MAKE_INT_BRANCH (uint8);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
406 MAKE_INT_BRANCH (uint16);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
407 MAKE_INT_BRANCH (uint32);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
408 MAKE_INT_BRANCH (uint64);
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
409
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
410 #undef MAKE_INT_BRANCH
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
411
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
412 /*
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
413 FIXME: This is what should happen when boolNDArray has max()
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
414 case btyp_bool:
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
415 retval = do_minmax_bin_op<boolNDArray> (argx, argy, ismin);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
416 break;
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
417 */
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
418 default:
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
419 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
420 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
421 }
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
422
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
423 // FIXME: Delete when boolNDArray has max()
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
424 if (xtyp == btyp_bool && ytyp == btyp_bool)
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
425 retval(0) = retval(0).bool_array_value ();
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
426
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
427 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
428
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
429 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
430 }
f5005d9510f4 Remove dispatched sparse functions and treat in the generic versions of the functions
David Bateman <dbateman@free.fr>
parents: 7231
diff changeset
431
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14501
diff changeset
432 DEFUN (min, args, nargout,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
433 "-*- texinfo -*-\n\
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14501
diff changeset
434 @deftypefn {Built-in Function} {} min (@var{x})\n\
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14501
diff changeset
435 @deftypefnx {Built-in Function} {} min (@var{x}, [], @var{dim})\n\
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14501
diff changeset
436 @deftypefnx {Built-in Function} {[@var{w}, @var{iw}] =} min (@var{x})\n\
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
437 @deftypefnx {Built-in Function} {} min (@var{x}, @var{y})\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
438 Find minimum values in the array @var{x}.\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
439 \n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
440 For a vector argument, return the minimum value. For a matrix argument,\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
441 return a row vector with the minimum value of each column. For a\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
442 multi-dimensional array, @code{min} operates along the first non-singleton\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
443 dimension.\n\
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
444 \n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
445 If the optional third argument @var{dim} is present then operate along\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
446 this dimension. In this case the second argument is ignored and should be\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
447 set to the empty matrix.\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
448 \n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
449 For two matrices (or a matrix and a scalar), return the pairwise minimum.\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
450 \n\
4522
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
451 Thus,\n\
3443
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe]
jwe
parents: 3418
diff changeset
452 \n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe]
jwe
parents: 3418
diff changeset
453 @example\n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe]
jwe
parents: 3418
diff changeset
454 min (min (@var{x}))\n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe]
jwe
parents: 3418
diff changeset
455 @end example\n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe]
jwe
parents: 3418
diff changeset
456 \n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe]
jwe
parents: 3418
diff changeset
457 @noindent\n\
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
458 returns the smallest element of the 2-D matrix @var{x}, and\n\
4522
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
459 \n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
460 @example\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
461 @group\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
462 min (2:5, pi)\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
463 @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
464 @end group\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
465 @end example\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10155
diff changeset
466 \n\
4522
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
467 @noindent\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
468 compares each element of the range @code{2:5} with @code{pi}, and returns a\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
469 row vector of the minimum values.\n\
3443
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe]
jwe
parents: 3418
diff changeset
470 \n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe]
jwe
parents: 3418
diff changeset
471 For complex arguments, the magnitude of the elements are used for\n\
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
472 comparison. If the magnitudes are identical, then the results are ordered\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
473 by phase angle in the range (-pi, pi]. Hence,\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
474 \n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
475 @example\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
476 @group\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
477 min ([-1 i 1 -i])\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
478 @result{} -i\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
479 @end group\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
480 @end example\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
481 \n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
482 @noindent\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
483 because all entries have magnitude 1, but -i has the smallest phase angle\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
484 with value -pi/2.\n\
3657
a908150a3a32 [project @ 2000-04-11 19:02:03 by jwe]
jwe
parents: 3443
diff changeset
485 \n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
486 If called with one input and two output arguments, @code{min} also returns\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
487 the first index of the minimum value(s). Thus,\n\
4522
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
488 \n\
3775
13905c3a24af [project @ 2001-02-06 01:56:59 by jwe]
jwe
parents: 3747
diff changeset
489 @example\n\
4522
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
490 @group\n\
9165
8c71a86c4bf4 Update section 17.5 (Utility Functions) of arith.txi
Rik <rdrider0-list@yahoo.com>
parents: 9141
diff changeset
491 [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
492 @result{} x = 0\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
493 ix = 3\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
494 @end group\n\
3657
a908150a3a32 [project @ 2000-04-11 19:02:03 by jwe]
jwe
parents: 3443
diff changeset
495 @end example\n\
9141
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi
Rik <rdrider0-list@yahoo.com>
parents: 9086
diff changeset
496 @seealso{max, cummin, cummax}\n\
4522
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
497 @end deftypefn")
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
498 {
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
499 return do_minmax_body (args, nargout, true);
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
500 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
501
7600
24abf5a702d9 Chop trailing singletons in min/max functions
David Bateman <dbateman@free.fr>
parents: 7505
diff changeset
502 /*
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
503 ## Test generic double class
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
504 %!assert (min ([1, 4, 2, 3]), 1)
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
505 %!assert (min ([1; -10; 5; -2]), -10)
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
506 %!assert (min ([4, 2i 4.999; -2, 2, 3+4i]), [-2, 2, 4.999])
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
507 ## Special routines for char arrays
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
508 %!assert (min (["abc", "ABC"]), 65)
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
509 %!assert (min (["abc"; "CBA"]), [67 66 65])
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
510 ## Special routines for logical arrays
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
511 %!assert (min (logical ([])), logical ([]))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
512 %!assert (min (logical ([0 0 1 0])), false)
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
513 %!assert (min (logical ([0 0 1 0; 0 1 1 0])), logical ([0 0 1 0]))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
514 ## Single values
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
515 %!assert (min (single ([1, 4, 2, 3])), single (1))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
516 %!assert (min (single ([1; -10; 5; -2])), single (-10))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
517 %!assert (min (single ([4, 2i 4.999; -2, 2, 3+4i])), single ([-2, 2, 4.999]))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
518 ## Integer values
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
519 %!assert (min (uint8 ([1, 4, 2, 3])), uint8 (1))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
520 %!assert (min (uint8 ([1; -10; 5; -2])), uint8 (-10))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
521 %!assert (min (int8 ([1, 4, 2, 3])), int8 (1))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
522 %!assert (min (int8 ([1; -10; 5; -2])), int8 (-10))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
523 %!assert (min (uint16 ([1, 4, 2, 3])), uint16 (1))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
524 %!assert (min (uint16 ([1; -10; 5; -2])), uint16 (-10))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
525 %!assert (min (int16 ([1, 4, 2, 3])), int16 (1))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
526 %!assert (min (int16 ([1; -10; 5; -2])), int16 (-10))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
527 %!assert (min (uint32 ([1, 4, 2, 3])), uint32 (1))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
528 %!assert (min (uint32 ([1; -10; 5; -2])), uint32 (-10))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
529 %!assert (min (int32 ([1, 4, 2, 3])), int32 (1))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
530 %!assert (min (int32 ([1; -10; 5; -2])), int32 (-10))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
531 %!assert (min (uint64 ([1, 4, 2, 3])), uint64 (1))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
532 %!assert (min (uint64 ([1; -10; 5; -2])), uint64 (-10))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
533 %!assert (min (int64 ([1, 4, 2, 3])), int64 (1))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
534 %!assert (min (int64 ([1; -10; 5; -2])), int64 (-10))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
535 ## Sparse double values
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
536 %!assert (min (sparse ([1, 4, 2, 3])), sparse (1))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
537 %!assert (min (sparse ([1; -10; 5; -2])), sparse(-10))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
538 ## FIXME: sparse doesn't order complex values by phase angle
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
539 %!xtest
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
540 %! assert (min (sparse ([4, 2i 4.999; -2, 2, 3+4i])), sparse ([-2, 2, 4.999]));
7600
24abf5a702d9 Chop trailing singletons in min/max functions
David Bateman <dbateman@free.fr>
parents: 7505
diff changeset
541
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
542 ## Test dimension argument
7600
24abf5a702d9 Chop trailing singletons in min/max functions
David Bateman <dbateman@free.fr>
parents: 7505
diff changeset
543 %!test
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
544 %! x = reshape (1:8, [2,2,2]);
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
545 %! assert (min (x, [], 1), reshape ([1, 3, 5, 7], [1,2,2]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
546 %! assert (min (x, [], 2), reshape ([1, 2, 5, 6], [2,1,2]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
547 %! [y, i] = min (x, [], 3);
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
548 %! assert (ndims (y), 2);
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
549 %! assert (y, [1, 3; 2, 4]);
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
550 %! assert (ndims (i), 2);
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
551 %! assert (i, [1, 1; 1, 1]);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
552
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
553 ## Test 2-output forms for various arg types
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
554 ## Special routines for char arrays
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
555 %!test
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
556 %! [y, i] = min (["abc", "ABC"]);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
557 %! assert (y, 65);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
558 %! assert (i, 4);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
559 ## Special routines for logical arrays
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
560 %!test
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
561 %! x = logical ([0 0 1 0]);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
562 %! [y, i] = min (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
563 %! assert (y, false);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
564 %! assert (i, 1);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
565 ## Special handling of ranges
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
566 %!test
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
567 %! rng = 1:2:10;
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
568 %! [y, i] = min (rng);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
569 %! assert (y, 1);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
570 %! assert (i, 1);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
571 %! rng = 10:-2:1;
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
572 %! [y, i] = min (rng);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
573 %! assert (y, 2);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
574 %! assert (i, 5);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
575
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
576 ## Test 2-input calling form for various arg types
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
577 ## Test generic double class
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
578 %!test
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
579 %! x = [1, 2, 3, 4]; y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
580 %! assert (min (x, y), [1 2 2 1]);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
581 %! assert (min (x, 3), [1 2 3 3]);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
582 %! assert (min (2, x), [1 2 2 2]);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
583 %! assert (min (x, 2.1i), [1 2 2.1i 2.1i]);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
584 ## FIXME: Ordering of complex results with equal magnitude is not by phase
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
585 ## angle in the 2-input form. Instead, it is in the order in which it
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
586 ## appears in the argument list.
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
587 %!xtest
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
588 %! x = [1, 2, 3, 4]; y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
589 %! assert (min (x, 2i), [2i 2i 3 4]);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
590 ## Special routines for char arrays
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
591 %!assert (min ("abc", "b"), [97 98 98])
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
592 %!assert (min ("b", "cba"), [98 98 97])
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
593 ## Special handling for logical arrays
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
594 %!assert (min ([true false], false), [false false])
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
595 %!assert (min (true, [true false]), [true false])
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
596 ## Single values
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
597 %!test
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
598 %! x = single ([1, 2, 3, 4]); y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
599 %! assert (min (x, y), single ([1 2 2 1]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
600 %! assert (min (x, 3), single ([1 2 3 3]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
601 %! assert (min (2, x), single ([1 2 2 2]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
602 %! assert (min (x, 2.1i), single ([1 2 2.1i 2.1i]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
603 ## Integer values
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
604 %!test
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
605 %! x = uint8 ([1, 2, 3, 4]); y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
606 %! assert (min (x, y), uint8 ([1 2 2 1]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
607 %! assert (min (x, 3), uint8 ([1 2 3 3]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
608 %! assert (min (2, x), uint8 ([1 2 2 2]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
609 %! x = int8 ([1, 2, 3, 4]); y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
610 %! assert (min (x, y), int8 ([1 2 2 1]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
611 %! assert (min (x, 3), int8 ([1 2 3 3]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
612 %! assert (min (2, x), int8 ([1 2 2 2]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
613 %! x = uint16 ([1, 2, 3, 4]); y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
614 %! assert (min (x, y), uint16 ([1 2 2 1]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
615 %! assert (min (x, 3), uint16 ([1 2 3 3]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
616 %! assert (min (2, x), uint16 ([1 2 2 2]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
617 %! x = int16 ([1, 2, 3, 4]); y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
618 %! assert (min (x, y), int16 ([1 2 2 1]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
619 %! assert (min (x, 3), int16 ([1 2 3 3]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
620 %! assert (min (2, x), int16 ([1 2 2 2]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
621 %! x = uint32 ([1, 2, 3, 4]); y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
622 %! assert (min (x, y), uint32 ([1 2 2 1]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
623 %! assert (min (x, 3), uint32 ([1 2 3 3]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
624 %! assert (min (2, x), uint32 ([1 2 2 2]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
625 %! x = int32 ([1, 2, 3, 4]); y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
626 %! assert (min (x, y), int32 ([1 2 2 1]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
627 %! assert (min (x, 3), int32 ([1 2 3 3]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
628 %! assert (min (2, x), int32 ([1 2 2 2]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
629 %! x = uint64 ([1, 2, 3, 4]); y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
630 %! assert (min (x, y), uint64 ([1 2 2 1]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
631 %! assert (min (x, 3), uint64 ([1 2 3 3]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
632 %! assert (min (2, x), uint64 ([1 2 2 2]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
633 %! x = int64 ([1, 2, 3, 4]); y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
634 %! assert (min (x, y), int64 ([1 2 2 1]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
635 %! assert (min (x, 3), int64 ([1 2 3 3]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
636 %! assert (min (2, x), int64 ([1 2 2 2]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
637 ## Sparse double values
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
638 %!test
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
639 %! x = sparse ([1, 2, 3, 4]); y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
640 %! assert (min (x, y), sparse ([1 2 2 1]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
641 %! assert (min (x, 3), sparse ([1 2 3 3]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
642 %! assert (min (2, x), sparse ([1 2 2 2]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
643 %! assert (min (x, 2.1i), sparse ([1 2 2.1i 2.1i]));
7600
24abf5a702d9 Chop trailing singletons in min/max functions
David Bateman <dbateman@free.fr>
parents: 7505
diff changeset
644
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
645 %!error min ()
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
646 %!error min (1, 2, 3, 4)
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
647 %!error <DIM must be a valid dimension> min ([1 2; 3 4], [], -3)
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
648 %!warning <second argument is ignored> min ([1 2 3 4], 2, 2);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
649 %!error <wrong type argument 'cell'> min ({1 2 3 4})
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
650 %!error <cannot compute min \(cell, scalar\)> min ({1, 2, 3}, 2)
7600
24abf5a702d9 Chop trailing singletons in min/max functions
David Bateman <dbateman@free.fr>
parents: 7505
diff changeset
651 */
24abf5a702d9 Chop trailing singletons in min/max functions
David Bateman <dbateman@free.fr>
parents: 7505
diff changeset
652
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14501
diff changeset
653 DEFUN (max, args, nargout,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
654 "-*- texinfo -*-\n\
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14501
diff changeset
655 @deftypefn {Built-in Function} {} max (@var{x})\n\
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14501
diff changeset
656 @deftypefnx {Built-in Function} {} max (@var{x}, [], @var{dim})\n\
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14501
diff changeset
657 @deftypefnx {Built-in Function} {[@var{w}, @var{iw}] =} max (@var{x})\n\
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
658 @deftypefnx {Built-in Function} {} max (@var{x}, @var{y})\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
659 Find maximum values in the array @var{x}.\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
660 \n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
661 For a vector argument, return the maximum value. For a matrix argument,\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
662 return a row vector with the maximum value of each column. For a\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
663 multi-dimensional array, @code{max} operates along the first non-singleton\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
664 dimension.\n\
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
665 \n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
666 If the optional third argument @var{dim} is present then operate along\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
667 this dimension. In this case the second argument is ignored and should be\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
668 set to the empty matrix.\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
669 \n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
670 For two matrices (or a matrix and a scalar), return the pairwise maximum.\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
671 \n\
4522
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
672 Thus,\n\
3443
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe]
jwe
parents: 3418
diff changeset
673 \n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe]
jwe
parents: 3418
diff changeset
674 @example\n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe]
jwe
parents: 3418
diff changeset
675 max (max (@var{x}))\n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe]
jwe
parents: 3418
diff changeset
676 @end example\n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe]
jwe
parents: 3418
diff changeset
677 \n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe]
jwe
parents: 3418
diff changeset
678 @noindent\n\
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
679 returns the largest element of the 2-D matrix @var{x}, and\n\
4522
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
680 \n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
681 @example\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
682 @group\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
683 max (2:5, pi)\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
684 @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
685 @end group\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
686 @end example\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10155
diff changeset
687 \n\
4522
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
688 @noindent\n\
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
689 compares each element of the range @code{2:5} with @code{pi}, and returns a\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
690 row vector of the maximum values.\n\
3443
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe]
jwe
parents: 3418
diff changeset
691 \n\
bf22deaf04ed [project @ 2000-01-17 08:28:27 by jwe]
jwe
parents: 3418
diff changeset
692 For complex arguments, the magnitude of the elements are used for\n\
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
693 comparison. If the magnitudes are identical, then the results are ordered\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
694 by phase angle in the range (-pi, pi]. Hence,\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
695 \n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
696 @example\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
697 @group\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
698 max ([-1 i 1 -i])\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
699 @result{} -1\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
700 @end group\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
701 @end example\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
702 \n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
703 @noindent\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
704 because all entries have magnitude 1, but -1 has the largest phase angle\n\
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
705 with value pi.\n\
3657
a908150a3a32 [project @ 2000-04-11 19:02:03 by jwe]
jwe
parents: 3443
diff changeset
706 \n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
707 If called with one input and two output arguments, @code{max} also returns\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
708 the first index of the maximum value(s). Thus,\n\
4522
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
709 \n\
3775
13905c3a24af [project @ 2001-02-06 01:56:59 by jwe]
jwe
parents: 3747
diff changeset
710 @example\n\
4522
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
711 @group\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
712 [x, ix] = max ([1, 3, 5, 2, 5])\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
713 @result{} x = 5\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
714 ix = 3\n\
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
715 @end group\n\
3657
a908150a3a32 [project @ 2000-04-11 19:02:03 by jwe]
jwe
parents: 3443
diff changeset
716 @end example\n\
9141
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi
Rik <rdrider0-list@yahoo.com>
parents: 9086
diff changeset
717 @seealso{min, cummax, cummin}\n\
4522
abdcb14e598d [project @ 2003-09-28 22:04:01 by jwe]
jwe
parents: 4309
diff changeset
718 @end deftypefn")
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
719 {
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
720 return do_minmax_body (args, nargout, false);
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
721 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
722
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
723 /*
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
724 ## Test generic double class
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
725 %!assert (max ([1, 4, 2, 3]), 4)
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
726 %!assert (max ([1; -10; 5; -2]), 5)
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
727 %!assert (max ([4, 2i 4.999; -2, 2, 3+4i]), [4, 2i, 3+4i])
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
728 ## Special routines for char arrays
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
729 %!assert (max (["abc", "ABC"]), 99)
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
730 %!assert (max (["abc"; "CBA"]), [97 98 99])
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
731 ## Special routines for logical arrays
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
732 %!assert (max (logical ([])), logical ([]))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
733 %!assert (max (logical ([0 0 1 0])), true)
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
734 %!assert (max (logical ([0 0 1 0; 0 1 0 0])), logical ([0 1 1 0]))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
735 ## Single values
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
736 %!assert (max (single ([1, 4, 2, 3])), single (4))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
737 %!assert (max (single ([1; -10; 5; -2])), single (5))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
738 %!assert (max (single ([4, 2i 4.999; -2, 2, 3+4i])), single ([4, 2i, 3+4i]))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
739 ## Integer values
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
740 %!assert (max (uint8 ([1, 4, 2, 3])), uint8 (4))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
741 %!assert (max (uint8 ([1; -10; 5; -2])), uint8 (5))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
742 %!assert (max (int8 ([1, 4, 2, 3])), int8 (4))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
743 %!assert (max (int8 ([1; -10; 5; -2])), int8 (5))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
744 %!assert (max (uint16 ([1, 4, 2, 3])), uint16 (4))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
745 %!assert (max (uint16 ([1; -10; 5; -2])), uint16 (5))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
746 %!assert (max (int16 ([1, 4, 2, 3])), int16 (4))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
747 %!assert (max (int16 ([1; -10; 5; -2])), int16 (5))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
748 %!assert (max (uint32 ([1, 4, 2, 3])), uint32 (4))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
749 %!assert (max (uint32 ([1; -10; 5; -2])), uint32 (5))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
750 %!assert (max (int32 ([1, 4, 2, 3])), int32 (4))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
751 %!assert (max (int32 ([1; -10; 5; -2])), int32 (5))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
752 %!assert (max (uint64 ([1, 4, 2, 3])), uint64 (4))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
753 %!assert (max (uint64 ([1; -10; 5; -2])), uint64 (5))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
754 %!assert (max (int64 ([1, 4, 2, 3])), int64 (4))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
755 %!assert (max (int64 ([1; -10; 5; -2])), int64 (5))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
756 ## Sparse double values
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
757 %!assert (max (sparse ([1, 4, 2, 3])), sparse (4))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
758 %!assert (max (sparse ([1; -10; 5; -2])), sparse(5))
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
759 %!assert (max (sparse ([4, 2i 4.999; -2, 2, 3+4i])), sparse ([4, 2i, 3+4i]))
7600
24abf5a702d9 Chop trailing singletons in min/max functions
David Bateman <dbateman@free.fr>
parents: 7505
diff changeset
760
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
761 ## Test dimension argument
7600
24abf5a702d9 Chop trailing singletons in min/max functions
David Bateman <dbateman@free.fr>
parents: 7505
diff changeset
762 %!test
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
763 %! x = reshape (1:8, [2,2,2]);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
764 %! assert (min (x, [], 1), reshape ([1, 3, 5, 7], [1,2,2]));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
765 %! assert (min (x, [], 2), reshape ([1, 2, 5, 6], [2,1,2]));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
766 %! [y, i] = min (x, [], 3);
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
767 %! assert (ndims (y), 2);
7600
24abf5a702d9 Chop trailing singletons in min/max functions
David Bateman <dbateman@free.fr>
parents: 7505
diff changeset
768 %! assert (y, [1, 3; 2, 4]);
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
769 %! assert (ndims (i), 2);
7600
24abf5a702d9 Chop trailing singletons in min/max functions
David Bateman <dbateman@free.fr>
parents: 7505
diff changeset
770 %! assert (i, [1, 1; 1, 1]);
24abf5a702d9 Chop trailing singletons in min/max functions
David Bateman <dbateman@free.fr>
parents: 7505
diff changeset
771
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
772 ## Test 2-output forms for various arg types
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
773 ## Special routines for char arrays
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
774 %!test
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
775 %! [y, i] = max (["abc", "ABC"]);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
776 %! assert (y, 99);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
777 %! assert (i, 3);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
778 ## Special routines for logical arrays
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
779 %!test
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
780 %! x = logical ([0 0 1 0]);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
781 %! [y, i] = max (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
782 %! assert (y, true);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
783 %! assert (i, 3);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
784 ## Special handling of ranges
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
785 %!test
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
786 %! rng = 1:2:10;
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
787 %! [y, i] = max (rng);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
788 %! assert (y, 9);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
789 %! assert (i, 5);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
790 %! rng = 10:-2:1;
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
791 %! [y, i] = max (rng);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
792 %! assert (y, 10);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
793 %! assert (i, 1);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
794
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
795 ## Test 2-input calling form for various arg types
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
796 ## Test generic double class
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
797 %!test
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
798 %! x = [1, 2, 3, 4]; y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
799 %! assert (max (x, y), [4 3 3 4]);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
800 %! assert (max (x, 3), [3 3 3 4]);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
801 %! assert (max (2, x), [2 2 3 4]);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
802 %! assert (max (x, 2.1i), [2.1i 2.1i 3 4]);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
803 ## FIXME: Ordering of complex results with equal magnitude is not by phase
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
804 ## angle in the 2-input form. Instead, it is in the order in which it
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
805 ## appears in the argument list.
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
806 %!xtest
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
807 %! x = [1, 2, 3, 4]; y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
808 %! assert (max (x, 2i), [2i 2i 3 4]);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
809 ## Special routines for char arrays
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
810 %!assert (max ("abc", "b"), [98 98 99])
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
811 %!assert (max ("b", "cba"), [99 98 98])
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
812 ## Special handling for logical arrays
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
813 %!assert (max ([true false], false), [true false])
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
814 %!assert (max (true, [false false]), [true true])
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
815 ## Single values
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
816 %!test
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
817 %! x = single ([1, 2, 3, 4]); y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
818 %! assert (max (x, y), single ([4 3 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
819 %! assert (max (x, 3), single ([3 3 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
820 %! assert (max (2, x), single ([2 2 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
821 %! assert (max (x, 2.1i), single ([2.1i 2.1i 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
822 ## Integer values
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
823 %!test
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
824 %! x = uint8 ([1, 2, 3, 4]); y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
825 %! assert (max (x, y), uint8 ([4 3 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
826 %! assert (max (x, 3), uint8 ([3 3 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
827 %! assert (max (2, x), uint8 ([2 2 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
828 %! x = int8 ([1, 2, 3, 4]); y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
829 %! assert (max (x, y), int8 ([4 3 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
830 %! assert (max (x, 3), int8 ([3 3 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
831 %! assert (max (2, x), int8 ([2 2 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
832 %! x = uint16 ([1, 2, 3, 4]); y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
833 %! assert (max (x, y), uint16 ([4 3 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
834 %! assert (max (x, 3), uint16 ([3 3 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
835 %! assert (max (2, x), uint16 ([2 2 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
836 %! x = int16 ([1, 2, 3, 4]); y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
837 %! assert (max (x, y), int16 ([4 3 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
838 %! assert (max (x, 3), int16 ([3 3 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
839 %! assert (max (2, x), int16 ([2 2 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
840 %! x = uint32 ([1, 2, 3, 4]); y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
841 %! assert (max (x, y), uint32 ([4 3 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
842 %! assert (max (x, 3), uint32 ([3 3 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
843 %! assert (max (2, x), uint32 ([2 2 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
844 %! x = int32 ([1, 2, 3, 4]); y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
845 %! assert (max (x, y), int32 ([4 3 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
846 %! assert (max (x, 3), int32 ([3 3 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
847 %! assert (max (2, x), int32 ([2 2 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
848 %! x = uint64 ([1, 2, 3, 4]); y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
849 %! assert (max (x, y), uint64 ([4 3 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
850 %! assert (max (x, 3), uint64 ([3 3 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
851 %! assert (max (2, x), uint64 ([2 2 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
852 %! x = int64 ([1, 2, 3, 4]); y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
853 %! assert (max (x, y), int64 ([4 3 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
854 %! assert (max (x, 3), int64 ([3 3 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
855 %! assert (max (2, x), int64 ([2 2 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
856 ## Sparse double values
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
857 %!test
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
858 %! x = sparse ([1, 2, 3, 4]); y = fliplr (x);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
859 %! assert (max (x, y), sparse ([4 3 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
860 %! assert (max (x, 3), sparse ([3 3 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
861 %! assert (max (2, x), sparse ([2 2 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
862 %! assert (max (x, 2.1i), sparse ([2.1i 2.1i 3 4]));
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
863
18076
42e6cdc76f4b max.cc: Add %!test for bug #40743.
Rik <rik@octave.org>
parents: 17787
diff changeset
864 ## Test for bug #40743
42e6cdc76f4b max.cc: Add %!test for bug #40743.
Rik <rik@octave.org>
parents: 17787
diff changeset
865 %!assert (max (zeros (1,0), ones (1,1)), zeros (1,0))
42e6cdc76f4b max.cc: Add %!test for bug #40743.
Rik <rik@octave.org>
parents: 17787
diff changeset
866 %!assert (max (sparse (zeros (1,0)), sparse (ones (1,1))), sparse (zeros (1,0)))
42e6cdc76f4b max.cc: Add %!test for bug #40743.
Rik <rik@octave.org>
parents: 17787
diff changeset
867
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
868 %!error max ()
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
869 %!error max (1, 2, 3, 4)
19412
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
870 %!error <DIM must be a valid dimension> max ([1 2; 3 4], [], -3)
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
871 %!warning <second argument is ignored> max ([1 2 3 4], 2, 2);
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
872 %!error <wrong type argument 'cell'> max ({1 2 3 4})
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
873 %!error <cannot compute max \(cell, scalar\)> max ({1, 2, 3}, 2)
78e424d31596 Overhaul max/min functions (fixes bug #43712).
Rik <rik@octave.org>
parents: 18227
diff changeset
874
7600
24abf5a702d9 Chop trailing singletons in min/max functions
David Bateman <dbateman@free.fr>
parents: 7505
diff changeset
875 */
24abf5a702d9 Chop trailing singletons in min/max functions
David Bateman <dbateman@free.fr>
parents: 7505
diff changeset
876
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
877 template <class ArrayType>
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
878 static octave_value_list
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
879 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
880 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
881 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
882 octave_value_list retval;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
883 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
884
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
885 if (nargout == 2)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
886 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
887 retval.resize (2);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
888 Array<octave_idx_type> idx;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
889 if (ismin)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
890 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
891 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
892 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
893
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
894 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
895 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
896 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
897 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
898 if (ismin)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
899 retval(0) = array.cummin (dim);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
900 else
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
901 retval(0) = array.cummax (dim);
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
902 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
903
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
904 return retval;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
905 }
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
906
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
907 static octave_value_list
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
908 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
909 int nargout, bool ismin)
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
910 {
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
911 octave_value_list retval;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
912
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
913 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
914
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
915 int nargin = args.length ();
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
916
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
917 if (nargin < 1 || nargin > 2)
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
918 print_usage ();
20743
b6408331bfa2 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20555
diff changeset
919
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
920 octave_value arg = args(0);
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
921 int dim = -1;
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
922 if (nargin == 2)
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
923 {
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
924 dim = args(1).int_value (true) - 1;
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
925
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
926 if (dim < 0)
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
927 {
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
928 error ("%s: DIM must be a valid dimension", func);
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
929 return retval;
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
930 }
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
931 }
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
932
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
933 switch (arg.builtin_type ())
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
934 {
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
935 case btyp_double:
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
936 retval = do_cumminmax_red_op<NDArray> (arg, nargout, dim, ismin);
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
937 break;
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
938
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
939 case btyp_complex:
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
940 retval = do_cumminmax_red_op<ComplexNDArray> (arg, nargout, dim,
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
941 ismin);
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
942 break;
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
943
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
944 case btyp_float:
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
945 retval = do_cumminmax_red_op<FloatNDArray> (arg, nargout, dim, ismin);
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
946 break;
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
947
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
948 case btyp_float_complex:
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
949 retval = do_cumminmax_red_op<FloatComplexNDArray> (arg, nargout, dim,
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
950 ismin);
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
951 break;
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
952
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
953 #define MAKE_INT_BRANCH(X) \
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
954 case btyp_ ## X: \
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
955 retval = do_cumminmax_red_op<X ## NDArray> (arg, nargout, dim, \
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
956 ismin); \
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
957 break;
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
958
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
959 MAKE_INT_BRANCH (int8);
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
960 MAKE_INT_BRANCH (int16);
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
961 MAKE_INT_BRANCH (int32);
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
962 MAKE_INT_BRANCH (int64);
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
963 MAKE_INT_BRANCH (uint8);
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
964 MAKE_INT_BRANCH (uint16);
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
965 MAKE_INT_BRANCH (uint32);
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
966 MAKE_INT_BRANCH (uint64);
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
967
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
968 #undef MAKE_INT_BRANCH
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
969
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
970 case btyp_bool:
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
971 {
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
972 retval = do_cumminmax_red_op<int8NDArray> (arg, nargout, dim,
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
973 ismin);
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
974 if (retval.length () > 0)
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
975 retval(0) = retval(0).bool_array_value ();
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
976 }
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
977 break;
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
978
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
979 default:
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
980 gripe_wrong_type_arg (func, arg);
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
981 }
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
982
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
983 return retval;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
984 }
8777
724c0f46d9d4 implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents: 7919
diff changeset
985
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14501
diff changeset
986 DEFUN (cummin, args, nargout,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
987 "-*- texinfo -*-\n\
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14501
diff changeset
988 @deftypefn {Built-in Function} {} cummin (@var{x})\n\
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14501
diff changeset
989 @deftypefnx {Built-in Function} {} cummin (@var{x}, @var{dim})\n\
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14501
diff changeset
990 @deftypefnx {Built-in Function} {[@var{w}, @var{iw}] =} cummin (@var{x})\n\
17403
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
991 Return the cumulative minimum values along dimension @var{dim}.\n\
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
992 \n\
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
993 If @var{dim} is unspecified it defaults to column-wise operation. For\n\
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
994 example:\n\
9141
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi
Rik <rdrider0-list@yahoo.com>
parents: 9086
diff changeset
995 \n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi
Rik <rdrider0-list@yahoo.com>
parents: 9086
diff changeset
996 @example\n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi
Rik <rdrider0-list@yahoo.com>
parents: 9086
diff changeset
997 @group\n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi
Rik <rdrider0-list@yahoo.com>
parents: 9086
diff changeset
998 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
999 @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
1000 @end group\n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi
Rik <rdrider0-list@yahoo.com>
parents: 9086
diff changeset
1001 @end example\n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi
Rik <rdrider0-list@yahoo.com>
parents: 9086
diff changeset
1002 \n\
17403
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1003 If called with two output arguments the index of the minimum value is also\n\
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1004 returned.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10155
diff changeset
1005 \n\
8777
724c0f46d9d4 implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents: 7919
diff changeset
1006 @example\n\
9064
7c02ec148a3c Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents: 8949
diff changeset
1007 @group\n\
17403
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1008 [w, iw] = cummin ([5 4 6 2 3 1])\n\
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1009 @result{}\n\
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1010 w = 5 4 4 2 2 1\n\
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1011 iw = 1 2 2 4 4 6\n\
9064
7c02ec148a3c Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents: 8949
diff changeset
1012 @end group\n\
8777
724c0f46d9d4 implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents: 7919
diff changeset
1013 @end example\n\
724c0f46d9d4 implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents: 7919
diff changeset
1014 \n\
9141
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi
Rik <rdrider0-list@yahoo.com>
parents: 9086
diff changeset
1015 @seealso{cummax, min, max}\n\
8777
724c0f46d9d4 implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents: 7919
diff changeset
1016 @end deftypefn")
724c0f46d9d4 implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents: 7919
diff changeset
1017 {
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
1018 return do_cumminmax_body (args, nargout, true);
8777
724c0f46d9d4 implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents: 7919
diff changeset
1019 }
724c0f46d9d4 implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents: 7919
diff changeset
1020
17403
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1021 /*
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1022 %!assert (cummin ([1, 4, 2, 3]), [1 1 1 1])
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1023 %!assert (cummin ([1; -10; 5; -2]), [1; -10; -10; -10])
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1024 %!assert (cummin ([4, i; -2, 2]), [4, i; -2, i])
19591
6b09dd576521 Fix cummin/cummax operations on rows when NaN element present (bug #44009).
Lachlan Andrew <lachlanbis@gmail.com>
parents: 19412
diff changeset
1025 %!assert (cummin ([1 2; NaN 1], 2), [1 1; NaN 1])
17403
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1026
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1027 %!test
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1028 %! x = reshape (1:8, [2,2,2]);
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1029 %! assert (cummin (x, 1), reshape ([1 1 3 3 5 5 7 7], [2,2,2]));
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1030 %! assert (cummin (x, 2), reshape ([1 2 1 2 5 6 5 6], [2,2,2]));
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1031 %! [w, iw] = cummin (x, 3);
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1032 %! assert (ndims (w), 3);
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1033 %! assert (w, repmat ([1 3; 2 4], [1 1 2]));
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1034 %! assert (ndims (iw), 3);
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1035 %! assert (iw, ones (2,2,2));
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1036
19591
6b09dd576521 Fix cummin/cummax operations on rows when NaN element present (bug #44009).
Lachlan Andrew <lachlanbis@gmail.com>
parents: 19412
diff changeset
1037
17403
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1038 %!error cummin ()
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1039 %!error cummin (1, 2, 3)
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1040 */
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1041
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14501
diff changeset
1042 DEFUN (cummax, args, nargout,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
1043 "-*- texinfo -*-\n\
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14501
diff changeset
1044 @deftypefn {Built-in Function} {} cummax (@var{x})\n\
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14501
diff changeset
1045 @deftypefnx {Built-in Function} {} cummax (@var{x}, @var{dim})\n\
17403
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1046 @deftypefnx {Built-in Function} {[@var{w}, @var{iw}] =} cummax (@dots{})\n\
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1047 Return the cumulative maximum values along dimension @var{dim}.\n\
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1048 \n\
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1049 If @var{dim} is unspecified it defaults to column-wise operation. For\n\
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1050 example:\n\
9141
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi
Rik <rdrider0-list@yahoo.com>
parents: 9086
diff changeset
1051 \n\
8777
724c0f46d9d4 implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents: 7919
diff changeset
1052 @example\n\
9141
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi
Rik <rdrider0-list@yahoo.com>
parents: 9086
diff changeset
1053 @group\n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi
Rik <rdrider0-list@yahoo.com>
parents: 9086
diff changeset
1054 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
1055 @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
1056 @end group\n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi
Rik <rdrider0-list@yahoo.com>
parents: 9086
diff changeset
1057 @end example\n\
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi
Rik <rdrider0-list@yahoo.com>
parents: 9086
diff changeset
1058 \n\
17403
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1059 If called with two output arguments the index of the maximum value is also\n\
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1060 returned.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10155
diff changeset
1061 \n\
8777
724c0f46d9d4 implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents: 7919
diff changeset
1062 @example\n\
9064
7c02ec148a3c Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents: 8949
diff changeset
1063 @group\n\
17403
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1064 [w, iw] = cummax ([1 3 2 6 4 5])\n\
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1065 @result{}\n\
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1066 w = 1 3 3 6 6 6\n\
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1067 iw = 1 2 2 4 4 4\n\
9064
7c02ec148a3c Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents: 8949
diff changeset
1068 @end group\n\
8777
724c0f46d9d4 implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents: 7919
diff changeset
1069 @end example\n\
724c0f46d9d4 implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents: 7919
diff changeset
1070 \n\
9141
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi
Rik <rdrider0-list@yahoo.com>
parents: 9086
diff changeset
1071 @seealso{cummin, max, min}\n\
8777
724c0f46d9d4 implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents: 7919
diff changeset
1072 @end deftypefn")
724c0f46d9d4 implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents: 7919
diff changeset
1073 {
9790
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents: 9732
diff changeset
1074 return do_cumminmax_body (args, nargout, false);
8777
724c0f46d9d4 implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents: 7919
diff changeset
1075 }
17403
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1076
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1077 /*
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1078 %!assert (cummax ([1, 4, 2, 3]), [1 4 4 4])
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1079 %!assert (cummax ([1; -10; 5; -2]), [1; 1; 5; 5])
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1080 %!assert (cummax ([4, i 4.9, -2, 2, 3+4i]), [4, 4, 4.9, 4.9, 4.9, 3+4i])
19591
6b09dd576521 Fix cummin/cummax operations on rows when NaN element present (bug #44009).
Lachlan Andrew <lachlanbis@gmail.com>
parents: 19412
diff changeset
1081 %!assert (cummax ([1 NaN 0; NaN NaN 1], 2), [1 1 1; NaN NaN 1])
17403
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1082
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1083 %!test
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1084 %! x = reshape (8:-1:1, [2,2,2]);
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1085 %! assert (cummax (x, 1), reshape ([8 8 6 6 4 4 2 2], [2,2,2]));
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1086 %! assert (cummax (x, 2), reshape ([8 7 8 7 4 3 4 3], [2,2,2]));
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1087 %! [w, iw] = cummax (x, 3);
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1088 %! assert (ndims (w), 3);
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1089 %! assert (w, repmat ([8 6; 7 5], [1 1 2]));
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1090 %! assert (ndims (iw), 3);
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1091 %! assert (iw, ones (2,2,2));
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1092
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1093 %!error cummax ()
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1094 %!error cummax (1, 2, 3)
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1095 */
db8b90a56298 doc: Reword docstrings for cummax, cummin.
Rik <rik@octave.org>
parents: 16370
diff changeset
1096