octave-nkf: liboctave/array/intNDArray.h annotate

annotate liboctave/array/intNDArray.h @ 20428:b2100e1659ac

maint: Use cuddled parentheses when indexing dimension_vectors. * libinterp/corefcn/besselj.cc, libinterp/corefcn/bsxfun.cc, libinterp/corefcn/data.cc, libinterp/corefcn/dot.cc, libinterp/corefcn/fft.cc, libinterp/corefcn/fft2.cc, libinterp/corefcn/tril.cc, libinterp/corefcn/typecast.cc, libinterp/octave-value/ov-base-int.cc, libinterp/octave-value/ov-base-mat.cc, libinterp/octave-value/ov-base-sparse.cc, libinterp/octave-value/ov-bool-mat.cc, libinterp/octave-value/ov-cell.cc, libinterp/octave-value/ov-cx-mat.cc, libinterp/octave-value/ov-flt-cx-mat.cc, libinterp/octave-value/ov-flt-re-mat.cc, libinterp/octave-value/ov-lazy-idx.cc, libinterp/octave-value/ov-re-mat.cc, libinterp/octave-value/ov-str-mat.cc, libinterp/octave-value/ov-struct.cc, liboctave/array/Array-util.cc, liboctave/array/Array.cc, liboctave/array/CMatrix.cc, liboctave/array/CNDArray.cc, liboctave/array/MArray.cc, liboctave/array/Sparse.cc, liboctave/array/dMatrix.cc, liboctave/array/dNDArray.cc, liboctave/array/fCMatrix.cc, liboctave/array/fCNDArray.cc, liboctave/array/fMatrix.cc, liboctave/array/fNDArray.cc, liboctave/operators/mx-inlines.cc: maint: Use cuddled parentheses when indexing dimension_vectors.

author	Rik <rik@octave.org>
date	Sat, 23 May 2015 21:46:44 -0700
parents	4197fc428c7d
children

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
19898 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 18890 diff changeset	3 Copyright (C) 2004-2015 John W. Eaton
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	4
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	5 This file is part of Octave.
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	6
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	7 Octave is free software; you can redistribute it and/or modify it
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	8 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: 6979 diff changeset	9 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6979 diff changeset	10 option) any later version.
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	11
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	12 Octave is distributed in the hope that it will be useful, but WITHOUT
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	15 for more details.
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	16
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	17 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	18 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6979 diff changeset	19 <http://www.gnu.org/licenses/>.
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 */
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	22
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	23 #if !defined (octave_intNDArray_h)
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	24 #define octave_intNDArray_h 1
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	25
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	26 #include "MArray.h"
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	27 #include "boolNDArray.h"
9721 192d94cff6c1 improve sum & implement the 'extra' option, refactor some code Jaroslav Hajek <highegg@gmail.com> parents: 9607 diff changeset	28 class NDArray;
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	29
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	30 template <class T>
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	31 class
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	32 intNDArray : public MArray<T>
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	33 {
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	34 public:
5992 4289ed95dde8 [project @ 2006-09-15 20:29:18 by jwe] jwe parents: 5943 diff changeset	35
14128 6258e5cd0f56 Use typename keyword to refer to templates Elias Pipping <pipping@exherbo.org> parents: 11586 diff changeset	36 using typename MArray<T>::element_type;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	37
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	38 intNDArray (void) : MArray<T> () { }
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	39
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	40 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	41
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	42 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	43
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	44 intNDArray (const dim_vector& dv, T val)
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	45 : MArray<T> (dv, val) { }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	46
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	47 template <class U>
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	48 intNDArray (const Array<U>& a) : MArray<T> (a) { }
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	49
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	50 template <class U>
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	51 intNDArray (const MArray<U>& a) : MArray<T> (a) { }
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	52
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	53 template <class U>
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	54 intNDArray (const intNDArray<U>& a) : MArray<T> (a) { }
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	55
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	56 intNDArray& operator = (const intNDArray<T>& a)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	57 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	58 MArray<T>::operator = (a);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	59 return *this;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	60 }
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	61
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	62 boolNDArray operator ! (void) const;
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	63
8626 1dce30ab0e72 don't convert NaN to logical in bool expressions John W. Eaton <jwe@octave.org> parents: 7620 diff changeset	64 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	65 bool any_element_not_one_or_zero (void) const;
c038c2947ee1 [project @ 2006-08-18 21:27:03 by jwe] jwe parents: 5775 diff changeset	66
7620 36594d5bbe13 Move diag function into the octave_value class David Bateman <dbateman@free.fr> parents: 7503 diff changeset	67 intNDArray diag (octave_idx_type k = 0) const;
6979 2883ea1c5c18 [project @ 2007-10-08 20:23:48 by dbateman] dbateman parents: 5992 diff changeset	68
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	69 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	70
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	71 intNDArray& changesign (void)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	72 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	73 MArray<T>::changesign ();
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	74 return *this;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	75 }
9607 1be3c73ed7b5 reuse temporary arrays in nested expressions Jaroslav Hajek <highegg@gmail.com> parents: 9513 diff changeset	76
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	77 // FIXME: this is not quite the right thing.
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	78
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	79 boolNDArray all (int dim = -1) const;
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	80 boolNDArray any (int dim = -1) const;
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	81
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	82 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	83 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	84 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	85 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	86
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	87 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	88 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	89 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	90 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	91
18890 8cc66f091584 Add "native" option to prod() (bug #40349). Rik <rik@octave.org> parents: 17769 diff changeset	92 intNDArray prod (int dim) const;
7113 a018c140f8aa [project @ 2007-11-07 00:28:01 by dbateman] dbateman parents: 7017 diff changeset	93 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	94 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	95 intNDArray cumsum (int dim) const;
7113 a018c140f8aa [project @ 2007-11-07 00:28:01 by dbateman] dbateman parents: 7017 diff changeset	96
9790 a5035bc7fbfb rewrite dispatch part & slightly improve min,max,cummin,cummax Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	97 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	98
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7189 diff changeset	99 intNDArray abs (void) const;
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7189 diff changeset	100 intNDArray signum (void) const;
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7189 diff changeset	101
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	102 intNDArray squeeze (void) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	103 { return intNDArray<T> (MArray<T>::squeeze ()); }
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	104
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	105 intNDArray transpose (void) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	106 { 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	107
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	108 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	109 const Array<octave_idx_type>& ra_idx);
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	110
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	111 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	112 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	113 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	114 const Array<octave_idx_type>& ra_idx);
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4902 diff changeset	115
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	116 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	117 const dim_vector& dimensions,
cbc402e64d83 untabify liboctave header files John W. Eaton <jwe@octave.org> parents: 10158 diff changeset	118 int start_dimension = 0);
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	119
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	120 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	121 const dim_vector& dimensions);
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	122 };
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	123
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	124 // i/o
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	125
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	126 template <class T>
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	127 std::ostream& operator << (std::ostream& os, const intNDArray<T>& a);
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	128
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	129 template <class T>
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	130 std::istream& operator >> (std::istream& is, intNDArray<T>& a);
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	131
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: diff changeset	132 #endif

Mercurial > hg > octave-nkf

annotate liboctave/array/intNDArray.h @ 20428:b2100e1659ac