octave: liboctave/array/intNDArray.h annotate

annotate liboctave/array/intNDArray.h @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.

author	John W. Eaton <jwe@octave.org>
date	Mon, 06 Jan 2020 22:29:51 -0500
parents	b442ec6dda5c
children	bd51beb6205e

rev	line source
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	1 /*
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	2
27919 1891570abac8 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27918 diff changeset	3 Copyright (C) 2004-2020 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27023 diff changeset	4
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27023 diff changeset	5 See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27023 diff changeset	6 or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27023 diff changeset	7
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	8
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	9 This file is part of Octave.
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	10
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23443 diff changeset	11 Octave is free software: you can redistribute it and/or modify it
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	12 under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23443 diff changeset	13 the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	14 (at your option) any later version.
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	15
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	16 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	17 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	19 GNU General Public License for more details.
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	20
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	21 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: 6979 diff changeset	22 along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23443 diff changeset	23 <https://www.gnu.org/licenses/>.
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	24
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	25 */
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	26
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 19697 diff changeset	27 #if ! defined (octave_intNDArray_h)
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	28 #define octave_intNDArray_h 1
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	29
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	30 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	31
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	32 #include "MArray.h"
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	33 #include "boolNDArray.h"
23443 3f1bf237908b maint: Eliminate <cfloat.h> header from liboctave files. Rik <rik@octave.org> parents: 23220 diff changeset	34
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9607 diff changeset	35 class NDArray;
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	36
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	37 template <typename T>
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	38 class
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	39 intNDArray : public MArray<T>
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	40 {
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	41 public:
5992 4289ed95dde8 [project @ 2006-09-15 20:29:18 by jwe] jwe parents: 5943 diff changeset	42
14128 6258e5cd0f56 Use typename keyword to refer to templates Elias Pipping <pipping@exherbo.org> parents: 11586 diff changeset	43 using typename MArray<T>::element_type;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	44
27023 fc256e9d882e use default ctors, dtors, and assignment ops in Matrix, intNDArray, and Cell John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	45 intNDArray (void) = default;
fc256e9d882e use default ctors, dtors, and assignment ops in Matrix, intNDArray, and Cell John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	46
fc256e9d882e use default ctors, dtors, and assignment ops in Matrix, intNDArray, and Cell John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	47 intNDArray (const intNDArray<T>& a) = default;
fc256e9d882e use default ctors, dtors, and assignment ops in Matrix, intNDArray, and Cell John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	48
fc256e9d882e use default ctors, dtors, and assignment ops in Matrix, intNDArray, and Cell John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	49 intNDArray& operator = (const intNDArray<T>& a) = default;
fc256e9d882e use default ctors, dtors, and assignment ops in Matrix, intNDArray, and Cell John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	50
fc256e9d882e use default ctors, dtors, and assignment ops in Matrix, intNDArray, and Cell John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	51 ~intNDArray (void) = default;
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	52
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	53 intNDArray (T val) : MArray<T> (dim_vector (1, 1), val) { }
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	54
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	55 intNDArray (const dim_vector& dv) : MArray<T> (dv) { }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	56
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	57 intNDArray (const dim_vector& dv, T val)
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	58 : MArray<T> (dv, val) { }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	59
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	60 template <typename U>
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	61 intNDArray (const Array<U>& a) : MArray<T> (a) { }
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	62
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	63 template <typename U>
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	64 intNDArray (const MArray<U>& a) : MArray<T> (a) { }
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	65
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	66 template <typename U>
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	67 intNDArray (const intNDArray<U>& a) : MArray<T> (a) { }
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	68
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	69 boolNDArray operator ! (void) const;
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	70
8626 1dce30ab0e72 don't convert NaN to logical in bool expressions John W. Eaton <jwe@octave.org> parents: 7620 diff changeset	71 bool any_element_is_nan (void) const { return false; }
5943 c038c2947ee1 [project @ 2006-08-18 21:27:03 by jwe] jwe parents: 5775 diff changeset	72 bool any_element_not_one_or_zero (void) const;
c038c2947ee1 [project @ 2006-08-18 21:27:03 by jwe] jwe parents: 5775 diff changeset	73
7620 36594d5bbe13 Move diag function into the octave_value class David Bateman <dbateman@free.fr> parents: 7503 diff changeset	74 intNDArray diag (octave_idx_type k = 0) const;
6979 2883ea1c5c18 [project @ 2007-10-08 20:23:48 by dbateman] dbateman parents: 5992 diff changeset	75
14557 e8e86ae3abbc make diag (x, m, n) return a proper diagonal matrix object (bug #36099) John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	76 intNDArray diag (octave_idx_type m, octave_idx_type n) const;
e8e86ae3abbc make diag (x, m, n) return a proper diagonal matrix object (bug #36099) John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	77
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	78 intNDArray& changesign (void)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	79 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	80 MArray<T>::changesign ();
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	81 return *this;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	82 }
9607 1be3c73ed7b5 reuse temporary arrays in nested expressions Jaroslav Hajek <highegg@gmail.com> parents: 9513 diff changeset	83
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	84 // FIXME: this is not quite the right thing.
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	85
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	86 boolNDArray all (int dim = -1) const;
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	87 boolNDArray any (int dim = -1) const;
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	88
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	89 intNDArray max (int dim = -1) const;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	90 intNDArray max (Array<octave_idx_type>& index, int dim = -1) const;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	91 intNDArray min (int dim = -1) const;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	92 intNDArray min (Array<octave_idx_type>& index, int dim = -1) const;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	93
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	94 intNDArray cummax (int dim = -1) const;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	95 intNDArray cummax (Array<octave_idx_type>& index, int dim = -1) const;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	96 intNDArray cummin (int dim = -1) const;
a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	97 intNDArray cummin (Array<octave_idx_type>& index, int dim = -1) const;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	98
18725 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 17769 diff changeset	99 intNDArray prod (int dim) const;
7113 a018c140f8aa [project @ 2007-11-07 00:28:01 by dbateman] dbateman parents: 7017 diff changeset	100 intNDArray sum (int dim) const;
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9607 diff changeset	101 NDArray dsum (int dim) const;
8780 ea76466605ba support native cumsum, gripe on overflow in sum/cumsum Jaroslav Hajek <highegg@gmail.com> parents: 8777 diff changeset	102 intNDArray cumsum (int dim) const;
7113 a018c140f8aa [project @ 2007-11-07 00:28:01 by dbateman] dbateman parents: 7017 diff changeset	103
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	104 intNDArray diff (octave_idx_type order = 1, int dim = -1) const;
9513 9f870f73ab7d implement built-in diff Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	105
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7189 diff changeset	106 intNDArray abs (void) const;
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7189 diff changeset	107 intNDArray signum (void) const;
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7189 diff changeset	108
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	109 intNDArray squeeze (void) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	110 { return intNDArray<T> (MArray<T>::squeeze ()); }
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	111
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	112 intNDArray transpose (void) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	113 { return intNDArray<T> (MArray<T>::transpose ()); }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	114
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	115 intNDArray concat (const intNDArray<T>& rb,
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	116 const Array<octave_idx_type>& ra_idx);
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	117
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	118 intNDArray& insert (const intNDArray<T>& a,
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	119 octave_idx_type r, octave_idx_type c);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	120 intNDArray& insert (const intNDArray<T>& a,
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	121 const Array<octave_idx_type>& ra_idx);
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4902 diff changeset	122
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	123 static void increment_index (Array<octave_idx_type>& ra_idx,
10312 cbc402e64d83 untabify liboctave header files John W. Eaton <jwe@octave.org> parents: 10158 diff changeset	124 const dim_vector& dimensions,
cbc402e64d83 untabify liboctave header files John W. Eaton <jwe@octave.org> parents: 10158 diff changeset	125 int start_dimension = 0);
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	126
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	127 static octave_idx_type compute_index (Array<octave_idx_type>& ra_idx,
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	128 const dim_vector& dimensions);
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	129 };
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	130
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	131 // i/o
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	132
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	133 template <typename T>
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	134 std::ostream& operator << (std::ostream& os, const intNDArray<T>& a);
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	135
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	136 template <typename T>
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	137 std::istream& operator >> (std::istream& is, intNDArray<T>& a);
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	138
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	139 #endif

Mercurial > octave

annotate liboctave/array/intNDArray.h @ 27919:1891570abac8