octave-dspies: liboctave/Array.h annotate

annotate liboctave/Array.h @ 12125:a21a3875ca83

implement a common class for reference counts

author	Jaroslav Hajek <highegg@gmail.com>
date	Thu, 20 Jan 2011 11:10:27 +0100
parents	12df7854fa7c
children	43cc49c7abd1

rev	line source
1993 1b57120c997b [project @ 1996-03-03 01:16:15 by jwe] jwe parents: 1989 diff changeset	1 // Template array classes
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	2 /*
ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	3
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 11507 diff changeset	4 Copyright (C) 1993-2011 John W. Eaton
fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 11507 diff changeset	5 Copyright (C) 2008-2009 Jaroslav Hajek
10521 4d1fc073fbb7 add some missing copyright stmts Jaroslav Hajek <highegg@gmail.com> parents: 10366 diff changeset	6 Copyright (C) 2010 VZLU Prague
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	7
ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	8 This file is part of Octave.
ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	9
ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	10 Octave is free software; you can redistribute it and/or modify it
ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	11 under the terms of the GNU General Public License as published by the
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6884 diff changeset	12 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6884 diff changeset	13 option) any later version.
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	14
ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	15 Octave is distributed in the hope that it will be useful, but WITHOUT
ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	16 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	17 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	18 for more details.
ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	19
ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	20 You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6884 diff changeset	21 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6884 diff changeset	22 <http://www.gnu.org/licenses/>.
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	23
ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	24 */
ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	25
382 e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe] jwe parents: 376 diff changeset	26 #if !defined (octave_Array_h)
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe] jwe parents: 376 diff changeset	27 #define octave_Array_h 1
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe] jwe parents: 376 diff changeset	28
1366 f75432dff006 [project @ 1995-09-05 23:56:42 by jwe] jwe parents: 1359 diff changeset	29 #include <cassert>
4152 f14251d33b01 [project @ 2002-11-06 18:41:50 by jwe] jwe parents: 4066 diff changeset	30 #include <cstddef>
3613 0a93682f89c8 [project @ 2000-03-17 10:58:25 by jwe] jwe parents: 3585 diff changeset	31
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	32 #include <algorithm>
8950 d865363208d6 include <iosfwd> instead of <iostream> in header files John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	33 #include <iosfwd>
3933 f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3928 diff changeset	34
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	35 #include "dim-vector.h"
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	36 #include "idx-vector.h"
8725 d5af326a3ede [mq]: sort-traits John W. Eaton <jwe@octave.org> parents: 8721 diff changeset	37 #include "lo-traits.h"
3613 0a93682f89c8 [project @ 2000-03-17 10:58:25 by jwe] jwe parents: 3585 diff changeset	38 #include "lo-utils.h"
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7017 diff changeset	39 #include "oct-sort.h"
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	40 #include "quit.h"
9773 01f897d8a130 optimize memory manipulation by arrays & indexing Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	41 #include "oct-mem.h"
12125 a21a3875ca83 implement a common class for reference counts Jaroslav Hajek <highegg@gmail.com> parents: 11586 diff changeset	42 #include "oct-refcount.h"
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7017 diff changeset	43
1359 a6994c934a50 [project @ 1995-09-05 21:30:26 by jwe] jwe parents: 1315 diff changeset	44 // One dimensional array class. Handles the reference counting for
a6994c934a50 [project @ 1995-09-05 21:30:26 by jwe] jwe parents: 1315 diff changeset	45 // all the derived classes.
238 780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe] jwe parents: 228 diff changeset	46
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	47 template <class T>
3585 d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3569 diff changeset	48 class
d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3569 diff changeset	49 Array
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	50 {
3504 5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe] jwe parents: 2847 diff changeset	51 protected:
1619 1a35c8c91349 [project @ 1995-11-04 11:07:21 by jwe] jwe parents: 1574 diff changeset	52
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	53 //--------------------------------------------------------------------
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	54 // The real representation of all arrays.
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	55 //--------------------------------------------------------------------
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	56
d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	57 class ArrayRep
d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	58 {
d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	59 public:
d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	60
d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	61 T *data;
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	62 octave_idx_type len;
12125 a21a3875ca83 implement a common class for reference counts Jaroslav Hajek <highegg@gmail.com> parents: 11586 diff changeset	63 octave_refcount<int> count;
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	64
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	65 ArrayRep (T *d, octave_idx_type l)
12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	66 : data (no_ctor_new<T> (l)), len (l), count (1)
12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	67 {
10364 96ed7c629bbd remove dangerous pointer-acquiring Array ctors Jaroslav Hajek <highegg@gmail.com> parents: 10358 diff changeset	68 copy_or_memcpy (l, d, data);
96ed7c629bbd remove dangerous pointer-acquiring Array ctors Jaroslav Hajek <highegg@gmail.com> parents: 10358 diff changeset	69 }
96ed7c629bbd remove dangerous pointer-acquiring Array ctors Jaroslav Hajek <highegg@gmail.com> parents: 10358 diff changeset	70
96ed7c629bbd remove dangerous pointer-acquiring Array ctors Jaroslav Hajek <highegg@gmail.com> parents: 10358 diff changeset	71 template <class U>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	72 ArrayRep (U *d, octave_idx_type l)
12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	73 : data (no_ctor_new<T> (l)), len (l), count (1)
12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	74 {
10364 96ed7c629bbd remove dangerous pointer-acquiring Array ctors Jaroslav Hajek <highegg@gmail.com> parents: 10358 diff changeset	75 std::copy (d, d+l, data);
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	76 }
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	77
d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	78 ArrayRep (void) : data (0), len (0), count (1) { }
d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	79
9780 6dafc60dde31 rename oct-mem functions Jaroslav Hajek <highegg@gmail.com> parents: 9773 diff changeset	80 explicit ArrayRep (octave_idx_type n) : data (no_ctor_new<T> (n)), len (n), count (1) { }
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	81
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	82 explicit ArrayRep (octave_idx_type n, const T& val)
9780 6dafc60dde31 rename oct-mem functions Jaroslav Hajek <highegg@gmail.com> parents: 9773 diff changeset	83 : data (no_ctor_new<T> (n)), len (n), count (1)
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	84 {
9780 6dafc60dde31 rename oct-mem functions Jaroslav Hajek <highegg@gmail.com> parents: 9773 diff changeset	85 fill_or_memset (n, val, data);
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	86 }
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	87
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	88 ArrayRep (const ArrayRep& a)
9780 6dafc60dde31 rename oct-mem functions Jaroslav Hajek <highegg@gmail.com> parents: 9773 diff changeset	89 : data (no_ctor_new<T> (a.len)), len (a.len), count (1)
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	90 {
9780 6dafc60dde31 rename oct-mem functions Jaroslav Hajek <highegg@gmail.com> parents: 9773 diff changeset	91 copy_or_memcpy (a.len, a.data, data);
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	92 }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	93
9780 6dafc60dde31 rename oct-mem functions Jaroslav Hajek <highegg@gmail.com> parents: 9773 diff changeset	94 ~ArrayRep (void) { no_ctor_delete<T> (data); }
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	95
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	96 octave_idx_type length (void) const { return len; }
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	97
4517 b4449b1193ac [project @ 2003-09-20 02:06:06 by jwe] jwe parents: 4513 diff changeset	98 private:
b4449b1193ac [project @ 2003-09-20 02:06:06 by jwe] jwe parents: 4513 diff changeset	99
b4449b1193ac [project @ 2003-09-20 02:06:06 by jwe] jwe parents: 4513 diff changeset	100 // No assignment!
b4449b1193ac [project @ 2003-09-20 02:06:06 by jwe] jwe parents: 4513 diff changeset	101
b4449b1193ac [project @ 2003-09-20 02:06:06 by jwe] jwe parents: 4513 diff changeset	102 ArrayRep& operator = (const ArrayRep& a);
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	103 };
d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	104
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	105 //--------------------------------------------------------------------
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	106
6884 1cbb8b606d63 [project @ 2007-09-10 20:43:26 by jwe] jwe parents: 6881 diff changeset	107 public:
1cbb8b606d63 [project @ 2007-09-10 20:43:26 by jwe] jwe parents: 6881 diff changeset	108
9556 948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	109 void make_unique (void)
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	110 {
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	111 if (rep->count > 1)
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	112 {
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	113 --rep->count;
10364 96ed7c629bbd remove dangerous pointer-acquiring Array ctors Jaroslav Hajek <highegg@gmail.com> parents: 10358 diff changeset	114 rep = new ArrayRep (slice_data, slice_len);
9556 948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	115 slice_data = rep->data;
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	116 }
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	117 }
238 780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe] jwe parents: 228 diff changeset	118
5900 c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe] jwe parents: 5775 diff changeset	119 typedef T element_type;
c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe] jwe parents: 5775 diff changeset	120
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	121 typedef typename ref_param<T>::type crefT;
84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	122
8725 d5af326a3ede [mq]: sort-traits John W. Eaton <jwe@octave.org> parents: 8721 diff changeset	123 typedef bool (*compare_fcn_type) (typename ref_param<T>::type,
10312 cbc402e64d83 untabify liboctave header files John W. Eaton <jwe@octave.org> parents: 10158 diff changeset	124 typename ref_param<T>::type);
8725 d5af326a3ede [mq]: sort-traits John W. Eaton <jwe@octave.org> parents: 8721 diff changeset	125
8524 937921654627 clean up Array and DiagArray2 Jaroslav Hajek <highegg@gmail.com> parents: 8523 diff changeset	126 protected:
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: 4834 diff changeset	127
11507 c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	128 dim_vector dimensions;
4518 382cb0ed8c14 [project @ 2003-09-20 18:08:40 by jwe] jwe parents: 4517 diff changeset	129
11507 c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	130 typename Array<T>::ArrayRep *rep;
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	131
8531 b01fef323c24 add some explaining comments Jaroslav Hajek <highegg@gmail.com> parents: 8524 diff changeset	132 // Rationale:
b01fef323c24 add some explaining comments Jaroslav Hajek <highegg@gmail.com> parents: 8524 diff changeset	133 // slice_data is a pointer to rep->data, denoting together with slice_len the
b01fef323c24 add some explaining comments Jaroslav Hajek <highegg@gmail.com> parents: 8524 diff changeset	134 // actual portion of the data referenced by this Array<T> object. This allows
b01fef323c24 add some explaining comments Jaroslav Hajek <highegg@gmail.com> parents: 8524 diff changeset	135 // to make shallow copies not only of a whole array, but also of contiguous
b01fef323c24 add some explaining comments Jaroslav Hajek <highegg@gmail.com> parents: 8524 diff changeset	136 // subranges. Every time rep is directly manipulated, slice_data and slice_len
b01fef323c24 add some explaining comments Jaroslav Hajek <highegg@gmail.com> parents: 8524 diff changeset	137 // need to be properly updated.
b01fef323c24 add some explaining comments Jaroslav Hajek <highegg@gmail.com> parents: 8524 diff changeset	138
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	139 T* slice_data;
ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	140 octave_idx_type slice_len;
ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	141
ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	142 // slice constructor
ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	143 Array (const Array<T>& a, const dim_vector& dv,
ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	144 octave_idx_type l, octave_idx_type u)
11507 c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	145 : dimensions (dv), rep(a.rep), slice_data (a.slice_data+l), slice_len (u-l)
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	146 {
ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	147 rep->count++;
10095 eb8ac0eed9f1 always chop dimension vector when constructing Arrays Jaroslav Hajek <highegg@gmail.com> parents: 10075 diff changeset	148 dimensions.chop_trailing_singletons ();
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	149 }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	150
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	151 private:
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	152
4585 a1ac9ab474a1 [project @ 2003-11-08 06:07:33 by jwe] jwe parents: 4567 diff changeset	153 typename Array<T>::ArrayRep *nil_rep (void) const
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	154 {
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	155 static typename Array<T>::ArrayRep *nr
10312 cbc402e64d83 untabify liboctave header files John W. Eaton <jwe@octave.org> parents: 10158 diff changeset	156 = new typename Array<T>::ArrayRep ();
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	157
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	158 return nr;
1550 d89532de8e72 [project @ 1995-10-08 01:12:20 by jwe] jwe parents: 1366 diff changeset	159 }
238 780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe] jwe parents: 228 diff changeset	160
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	161 public:
238 780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe] jwe parents: 228 diff changeset	162
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	163 // Empty ctor (0x0).
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	164
1550 d89532de8e72 [project @ 1995-10-08 01:12:20 by jwe] jwe parents: 1366 diff changeset	165 Array (void)
11507 c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	166 : dimensions (), rep (nil_rep ()), slice_data (rep->data),
c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	167 slice_len (rep->len)
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	168 {
12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	169 rep->count++;
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	170 }
1550 d89532de8e72 [project @ 1995-10-08 01:12:20 by jwe] jwe parents: 1366 diff changeset	171
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	172 // Obsolete 1D ctor (there are no 1D arrays).
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	173 explicit Array (octave_idx_type n) GCC_ATTR_DEPRECATED
11507 c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	174 : dimensions (n, 1), rep (new typename Array<T>::ArrayRep (n)),
c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	175 slice_data (rep->data), slice_len (rep->len)
c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	176 { }
1619 1a35c8c91349 [project @ 1995-11-04 11:07:21 by jwe] jwe parents: 1574 diff changeset	177
11570 57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	178 // Obsolete initialized 1D ctor (there are no 1D arrays).
57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	179 explicit Array (octave_idx_type n, const T& val) GCC_ATTR_DEPRECATED
57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	180 : dimensions (n, 1), rep (new typename Array<T>::ArrayRep (n)),
11507 c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	181 slice_data (rep->data), slice_len (rep->len)
11570 57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	182 {
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	183 fill (val);
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	184 }
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	185
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	186 // nD uninitialized ctor.
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	187 explicit Array (const dim_vector& dv)
11507 c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	188 : dimensions (dv),
c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	189 rep (new typename Array<T>::ArrayRep (dv.safe_numel ())),
c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	190 slice_data (rep->data), slice_len (rep->len)
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	191 {
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	192 dimensions.chop_trailing_singletons ();
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	193 }
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	194
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	195 // nD initialized ctor.
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	196 explicit Array (const dim_vector& dv, const T& val)
11507 c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	197 : dimensions (dv),
c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	198 rep (new typename Array<T>::ArrayRep (dv.safe_numel ())),
c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	199 slice_data (rep->data), slice_len (rep->len)
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	200 {
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	201 fill (val);
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	202 dimensions.chop_trailing_singletons ();
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	203 }
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	204
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	205 // Reshape constructor.
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	206 Array (const Array<T>& a, const dim_vector& dv);
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	207
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: 4834 diff changeset	208 // Type conversion case.
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: 4834 diff changeset	209 template <class U>
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: 4834 diff changeset	210 Array (const Array<U>& a)
11507 c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	211 : dimensions (a.dims ()),
c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	212 rep (new typename Array<T>::ArrayRep (a.data (), a.length ())),
c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	213 slice_data (rep->data), slice_len (rep->len)
c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	214 { }
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: 4834 diff changeset	215
bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: 4834 diff changeset	216 // No type conversion case.
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	217 Array (const Array<T>& a)
11507 c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	218 : dimensions (a.dimensions), rep (a.rep), slice_data (a.slice_data),
c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	219 slice_len (a.slice_len)
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	220 {
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	221 rep->count++;
1550 d89532de8e72 [project @ 1995-10-08 01:12:20 by jwe] jwe parents: 1366 diff changeset	222 }
d89532de8e72 [project @ 1995-10-08 01:12:20 by jwe] jwe parents: 1366 diff changeset	223
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	224 public:
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	225
9556 948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	226 ~Array (void)
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	227 {
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	228 if (--rep->count <= 0)
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	229 delete rep;
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	230 }
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	231
9556 948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	232 Array<T>& operator = (const Array<T>& a)
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	233 {
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	234 if (this != &a)
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	235 {
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	236 if (--rep->count <= 0)
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	237 delete rep;
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	238
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	239 rep = a.rep;
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	240 rep->count++;
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	241
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	242 dimensions = a.dimensions;
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	243 slice_data = a.slice_data;
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	244 slice_len = a.slice_len;
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	245 }
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	246
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	247 return *this;
948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	248 }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	249
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	250 void fill (const T& val);
9624 3fc7272937ce implement Array<T>::clear overloads Jaroslav Hajek <highegg@gmail.com> parents: 9556 diff changeset	251
9546 1beb23d2b892 optimize op= in common cases Jaroslav Hajek <highegg@gmail.com> parents: 9341 diff changeset	252 void clear (void);
9624 3fc7272937ce implement Array<T>::clear overloads Jaroslav Hajek <highegg@gmail.com> parents: 9556 diff changeset	253 void clear (const dim_vector& dv);
3fc7272937ce implement Array<T>::clear overloads Jaroslav Hajek <highegg@gmail.com> parents: 9556 diff changeset	254
3fc7272937ce implement Array<T>::clear overloads Jaroslav Hajek <highegg@gmail.com> parents: 9556 diff changeset	255 void clear (octave_idx_type r, octave_idx_type c)
3fc7272937ce implement Array<T>::clear overloads Jaroslav Hajek <highegg@gmail.com> parents: 9556 diff changeset	256 { clear (dim_vector (r, c)); }
238 780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe] jwe parents: 228 diff changeset	257
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	258 octave_idx_type capacity (void) const { return slice_len; }
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	259 octave_idx_type length (void) const { return capacity (); }
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	260 octave_idx_type nelem (void) const { return capacity (); }
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	261 octave_idx_type numel (void) const { return nelem (); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	262
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	263 octave_idx_type dim1 (void) const { return dimensions(0); }
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	264 octave_idx_type dim2 (void) const { return dimensions(1); }
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	265 octave_idx_type dim3 (void) const { return dimensions(2); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	266
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	267 // Return the array as a column vector.
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	268 Array<T> as_column (void) const
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	269 {
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	270 Array<T> retval (*this);
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	271 if (dimensions.length () != 2 \|\| dimensions(1) != 1)
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	272 retval.dimensions = dim_vector (numel (), 1);
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	273
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	274 return retval;
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	275 }
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	276
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	277 // Return the array as a row vector.
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	278 Array<T> as_row (void) const
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	279 {
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	280 Array<T> retval (*this);
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	281 if (dimensions.length () != 2 \|\| dimensions(0) != 1)
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	282 retval.dimensions = dim_vector (1, numel ());
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	283
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	284 return retval;
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	285 }
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	286
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	287 // Return the array as a matrix.
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	288 Array<T> as_matrix (void) const
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	289 {
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	290 Array<T> retval (*this);
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	291 if (dimensions.length () != 2)
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	292 retval.dimensions = dimensions.redim (2);
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	293
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	294 return retval;
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	295 }
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	296
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	297 octave_idx_type rows (void) const { return dim1 (); }
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	298 octave_idx_type cols (void) const { return dim2 (); }
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	299 octave_idx_type columns (void) const { return dim2 (); }
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	300 octave_idx_type pages (void) const { return dim3 (); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	301
10358 72fab01e5d68 improve some size_t queries Jaroslav Hajek <highegg@gmail.com> parents: 10352 diff changeset	302 size_t byte_size (void) const { return static_cast<size_t> (numel ()) * sizeof (T); }
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: 4834 diff changeset	303
9026 6890d411a0b8 adjust some array dim query methods Jaroslav Hajek <highegg@gmail.com> parents: 9025 diff changeset	304 // Return a const-reference so that dims ()(i) works efficiently.
6890d411a0b8 adjust some array dim query methods Jaroslav Hajek <highegg@gmail.com> parents: 9025 diff changeset	305 const dim_vector& dims (void) const { return dimensions; }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	306
4532 01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4530 diff changeset	307 Array<T> squeeze (void) const;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	308
10095 eb8ac0eed9f1 always chop dimension vector when constructing Arrays Jaroslav Hajek <highegg@gmail.com> parents: 10075 diff changeset	309 void chop_trailing_singletons (void) GCC_ATTR_DEPRECATED
4703 72c28fd651c4 [project @ 2004-01-22 00:01:09 by jwe] jwe parents: 4625 diff changeset	310 { dimensions.chop_trailing_singletons (); }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	311
10366 e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	312 octave_idx_type compute_index (octave_idx_type i, octave_idx_type j) const;
e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	313 octave_idx_type compute_index (octave_idx_type i, octave_idx_type j, octave_idx_type k) const;
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	314 octave_idx_type compute_index (const Array<octave_idx_type>& ra_idx) const;
4517 b4449b1193ac [project @ 2003-09-20 02:06:06 by jwe] jwe parents: 4513 diff changeset	315
10645 8645b7087859 abstract scalar index checking off Array<T> (prep for struct optimizations) Jaroslav Hajek <highegg@gmail.com> parents: 10636 diff changeset	316 octave_idx_type compute_index_unchecked (const Array<octave_idx_type>& ra_idx) const
8645b7087859 abstract scalar index checking off Array<T> (prep for struct optimizations) Jaroslav Hajek <highegg@gmail.com> parents: 10636 diff changeset	317 { return dimensions.compute_index (ra_idx.data (), ra_idx.length ()); }
8645b7087859 abstract scalar index checking off Array<T> (prep for struct optimizations) Jaroslav Hajek <highegg@gmail.com> parents: 10636 diff changeset	318
2108 2b67abb63030 [project @ 1996-04-30 10:44:17 by jwe] jwe parents: 2049 diff changeset	319 // No checking, even for multiple references, ever.
2b67abb63030 [project @ 1996-04-30 10:44:17 by jwe] jwe parents: 2049 diff changeset	320
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	321 T& xelem (octave_idx_type n) { return slice_data [n]; }
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	322 crefT xelem (octave_idx_type n) const { return slice_data [n]; }
2108 2b67abb63030 [project @ 1996-04-30 10:44:17 by jwe] jwe parents: 2049 diff changeset	323
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	324 T& xelem (octave_idx_type i, octave_idx_type j) { return xelem (dim1()*j+i); }
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	325 crefT xelem (octave_idx_type i, octave_idx_type j) const { return xelem (dim1()*j+i); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	326
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	327 T& xelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	328 { return xelem (i, dim2()*k+j); }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	329 crefT xelem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	330 { return xelem (i, dim2()*k+j); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	331
6867 83619ae96c1d [project @ 2007-09-06 12:08:44 by dbateman] dbateman parents: 6708 diff changeset	332 T& xelem (const Array<octave_idx_type>& ra_idx)
10645 8645b7087859 abstract scalar index checking off Array<T> (prep for struct optimizations) Jaroslav Hajek <highegg@gmail.com> parents: 10636 diff changeset	333 { return xelem (compute_index_unchecked (ra_idx)); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	334
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	335 crefT xelem (const Array<octave_idx_type>& ra_idx) const
10645 8645b7087859 abstract scalar index checking off Array<T> (prep for struct optimizations) Jaroslav Hajek <highegg@gmail.com> parents: 10636 diff changeset	336 { return xelem (compute_index_unchecked (ra_idx)); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	337
5775 ace8d8d26933 [project @ 2006-04-24 19:13:06 by jwe] jwe parents: 5632 diff changeset	338 // FIXME -- would be nice to fix this so that we don't
2006 95e952f72d66 [project @ 1996-03-04 00:33:32 by jwe] jwe parents: 2005 diff changeset	339 // unnecessarily force a copy, but that is not so easy, and I see no
95e952f72d66 [project @ 1996-03-04 00:33:32 by jwe] jwe parents: 2005 diff changeset	340 // clean way to do it.
95e952f72d66 [project @ 1996-03-04 00:33:32 by jwe] jwe parents: 2005 diff changeset	341
10366 e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	342 T& checkelem (octave_idx_type n);
e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	343 T& checkelem (octave_idx_type i, octave_idx_type j);
e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	344 T& checkelem (octave_idx_type i, octave_idx_type j, octave_idx_type k);
e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	345 T& checkelem (const Array<octave_idx_type>& ra_idx);
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	346
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	347 T& elem (octave_idx_type n)
2108 2b67abb63030 [project @ 1996-04-30 10:44:17 by jwe] jwe parents: 2049 diff changeset	348 {
2b67abb63030 [project @ 1996-04-30 10:44:17 by jwe] jwe parents: 2049 diff changeset	349 make_unique ();
2109 356f70c8fcbd [project @ 1996-04-30 12:31:30 by jwe] jwe parents: 2108 diff changeset	350 return xelem (n);
2108 2b67abb63030 [project @ 1996-04-30 10:44:17 by jwe] jwe parents: 2049 diff changeset	351 }
2306 2fbf9bb1cd7a [project @ 1996-07-09 16:49:03 by jwe] jwe parents: 2109 diff changeset	352
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	353 T& elem (octave_idx_type i, octave_idx_type j) { return elem (dim1()*j+i); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	354
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	355 T& elem (octave_idx_type i, octave_idx_type j, octave_idx_type k) { return elem (i, dim2()*k+j); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	356
6867 83619ae96c1d [project @ 2007-09-06 12:08:44 by dbateman] dbateman parents: 6708 diff changeset	357 T& elem (const Array<octave_idx_type>& ra_idx)
10645 8645b7087859 abstract scalar index checking off Array<T> (prep for struct optimizations) Jaroslav Hajek <highegg@gmail.com> parents: 10636 diff changeset	358 { return Array<T>::elem (compute_index_unchecked (ra_idx)); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	359
2306 2fbf9bb1cd7a [project @ 1996-07-09 16:49:03 by jwe] jwe parents: 2109 diff changeset	360 #if defined (BOUNDS_CHECKING)
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	361 T& operator () (octave_idx_type n) { return checkelem (n); }
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	362 T& operator () (octave_idx_type i, octave_idx_type j) { return checkelem (i, j); }
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	363 T& operator () (octave_idx_type i, octave_idx_type j, octave_idx_type k) { return checkelem (i, j, k); }
6867 83619ae96c1d [project @ 2007-09-06 12:08:44 by dbateman] dbateman parents: 6708 diff changeset	364 T& operator () (const Array<octave_idx_type>& ra_idx) { return checkelem (ra_idx); }
2306 2fbf9bb1cd7a [project @ 1996-07-09 16:49:03 by jwe] jwe parents: 2109 diff changeset	365 #else
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	366 T& operator () (octave_idx_type n) { return elem (n); }
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	367 T& operator () (octave_idx_type i, octave_idx_type j) { return elem (i, j); }
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	368 T& operator () (octave_idx_type i, octave_idx_type j, octave_idx_type k) { return elem (i, j, k); }
6867 83619ae96c1d [project @ 2007-09-06 12:08:44 by dbateman] dbateman parents: 6708 diff changeset	369 T& operator () (const Array<octave_idx_type>& ra_idx) { return elem (ra_idx); }
2006 95e952f72d66 [project @ 1996-03-04 00:33:32 by jwe] jwe parents: 2005 diff changeset	370 #endif
95e952f72d66 [project @ 1996-03-04 00:33:32 by jwe] jwe parents: 2005 diff changeset	371
10366 e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	372 crefT checkelem (octave_idx_type n) const;
e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	373 crefT checkelem (octave_idx_type i, octave_idx_type j) const;
e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	374 crefT checkelem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const;
e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	375 crefT checkelem (const Array<octave_idx_type>& ra_idx) const;
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	376
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	377 crefT elem (octave_idx_type n) const { return xelem (n); }
2306 2fbf9bb1cd7a [project @ 1996-07-09 16:49:03 by jwe] jwe parents: 2109 diff changeset	378
10366 e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	379 crefT elem (octave_idx_type i, octave_idx_type j) const { return xelem (i, j); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	380
10366 e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	381 crefT elem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const { return xelem (i, j, k); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	382
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	383 crefT elem (const Array<octave_idx_type>& ra_idx) const
10645 8645b7087859 abstract scalar index checking off Array<T> (prep for struct optimizations) Jaroslav Hajek <highegg@gmail.com> parents: 10636 diff changeset	384 { return Array<T>::xelem (compute_index_unchecked (ra_idx)); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	385
2108 2b67abb63030 [project @ 1996-04-30 10:44:17 by jwe] jwe parents: 2049 diff changeset	386 #if defined (BOUNDS_CHECKING)
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	387 crefT operator () (octave_idx_type n) const { return checkelem (n); }
84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	388 crefT operator () (octave_idx_type i, octave_idx_type j) const { return checkelem (i, j); }
84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	389 crefT operator () (octave_idx_type i, octave_idx_type j, octave_idx_type k) const { return checkelem (i, j, k); }
84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	390 crefT operator () (const Array<octave_idx_type>& ra_idx) const { return checkelem (ra_idx); }
2006 95e952f72d66 [project @ 1996-03-04 00:33:32 by jwe] jwe parents: 2005 diff changeset	391 #else
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	392 crefT operator () (octave_idx_type n) const { return elem (n); }
84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	393 crefT operator () (octave_idx_type i, octave_idx_type j) const { return elem (i, j); }
84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	394 crefT operator () (octave_idx_type i, octave_idx_type j, octave_idx_type k) const { return elem (i, j, k); }
84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	395 crefT operator () (const Array<octave_idx_type>& ra_idx) const { return elem (ra_idx); }
2006 95e952f72d66 [project @ 1996-03-04 00:33:32 by jwe] jwe parents: 2005 diff changeset	396 #endif
95e952f72d66 [project @ 1996-03-04 00:33:32 by jwe] jwe parents: 2005 diff changeset	397
9731 7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	398 // Fast extractors. All of these produce shallow copies.
7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	399 // Warning: none of these do check bounds, unless BOUNDS_CHECKING is on!
7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	400
7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	401 // Extract column: A(:,k+1).
7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	402 Array<T> column (octave_idx_type k) const;
7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	403 // Extract page: A(:,:,k+1).
7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	404 Array<T> page (octave_idx_type k) const;
7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	405
7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	406 // Extract a slice from this array as a column vector: A(:)(lo+1:up).
7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	407 // Must be 0 <= lo && up <= numel. May be up < lo.
7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	408 Array<T> linear_slice (octave_idx_type lo, octave_idx_type up) const;
7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	409
10352 a3635bc1ea19 remove Array2 Jaroslav Hajek <highegg@gmail.com> parents: 10350 diff changeset	410 Array<T> reshape (octave_idx_type nr, octave_idx_type nc) const
11570 57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	411 { return Array<T> (*this, dim_vector (nr, nc)); }
10352 a3635bc1ea19 remove Array2 Jaroslav Hajek <highegg@gmail.com> parents: 10350 diff changeset	412
9731 7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	413 Array<T> reshape (const dim_vector& new_dims) const
7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	414 { return Array<T> (*this, new_dims); }
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4559 diff changeset	415
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	416 Array<T> permute (const Array<octave_idx_type>& vec, bool inv = false) const;
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	417 Array<T> ipermute (const Array<octave_idx_type>& vec) const
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4587 diff changeset	418 { return permute (vec, true); }
77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4587 diff changeset	419
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	420 bool is_square (void) const { return (dim1 () == dim2 ()); }
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	421
4559 802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4548 diff changeset	422 bool is_empty (void) const { return numel () == 0; }
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4548 diff changeset	423
9026 6890d411a0b8 adjust some array dim query methods Jaroslav Hajek <highegg@gmail.com> parents: 9025 diff changeset	424 bool is_vector (void) const { return dimensions.is_vector (); }
6890d411a0b8 adjust some array dim query methods Jaroslav Hajek <highegg@gmail.com> parents: 9025 diff changeset	425
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	426 Array<T> transpose (void) const;
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7717 diff changeset	427 Array<T> hermitian (T (*fcn) (const T&) = 0) const;
238 780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe] jwe parents: 228 diff changeset	428
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	429 const T *data (void) const { return slice_data; }
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	430
3952 945e8c160191 [project @ 2002-05-23 17:18:12 by jwe] jwe parents: 3944 diff changeset	431 const T *fortran_vec (void) const { return data (); }
945e8c160191 [project @ 2002-05-23 17:18:12 by jwe] jwe parents: 3944 diff changeset	432
238 780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe] jwe parents: 228 diff changeset	433 T *fortran_vec (void);
1560 27a03373de41 [project @ 1995-10-12 07:22:26 by jwe] jwe parents: 1550 diff changeset	434
9546 1beb23d2b892 optimize op= in common cases Jaroslav Hajek <highegg@gmail.com> parents: 9341 diff changeset	435 bool is_shared (void) { return rep->count > 1; }
1beb23d2b892 optimize op= in common cases Jaroslav Hajek <highegg@gmail.com> parents: 9341 diff changeset	436
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	437 int ndims (void) const { return dimensions.length (); }
1560 27a03373de41 [project @ 1995-10-12 07:22:26 by jwe] jwe parents: 1550 diff changeset	438
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	439 // Indexing without resizing.
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	440
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	441 Array<T> index (const idx_vector& i) const;
1560 27a03373de41 [project @ 1995-10-12 07:22:26 by jwe] jwe parents: 1550 diff changeset	442
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	443 Array<T> index (const idx_vector& i, const idx_vector& j) const;
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	444
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	445 Array<T> index (const Array<idx_vector>& ia) const;
1560 27a03373de41 [project @ 1995-10-12 07:22:26 by jwe] jwe parents: 1550 diff changeset	446
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	447 static const T& resize_fill_value ();
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	448
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	449 // Resizing (with fill).
1560 27a03373de41 [project @ 1995-10-12 07:22:26 by jwe] jwe parents: 1550 diff changeset	450
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	451 void resize1 (octave_idx_type n, const T& rfv = resize_fill_value ());
1560 27a03373de41 [project @ 1995-10-12 07:22:26 by jwe] jwe parents: 1550 diff changeset	452
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	453 void resize (octave_idx_type n) GCC_ATTR_DEPRECATED
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	454 { resize1 (n); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	455
11574 a83bad07f7e3 attempt better backward compatibility for Array resize functions John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	456 void resize (octave_idx_type nr, octave_idx_type nc,
a83bad07f7e3 attempt better backward compatibility for Array resize functions John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	457 const T& rfv = resize_fill_value ()) GCC_ATTR_DEPRECATED
a83bad07f7e3 attempt better backward compatibility for Array resize functions John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	458 {
a83bad07f7e3 attempt better backward compatibility for Array resize functions John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	459 resize2 (nr, nc, rfv);
a83bad07f7e3 attempt better backward compatibility for Array resize functions John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	460 }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	461
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	462 void resize (const dim_vector& dv, const T& rfv = resize_fill_value ());
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	463
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	464 // Indexing with possible resizing and fill
8333 9238637cb81c style fixes John W. Eaton <jwe@octave.org> parents: 8290 diff changeset	465 // FIXME -- this is really a corner case, that should better be
9238637cb81c style fixes John W. Eaton <jwe@octave.org> parents: 8290 diff changeset	466 // handled directly in liboctinterp.
3933 f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3928 diff changeset	467
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	468 Array<T> index (const idx_vector& i, bool resize_ok,
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	469 const T& rfv = resize_fill_value ()) const;
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	470
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	471 Array<T> index (const idx_vector& i, const idx_vector& j,
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	472 bool resize_ok, const T& rfv = resize_fill_value ()) const;
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	473
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	474 Array<T> index (const Array<idx_vector>& ia,
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	475 bool resize_ok, const T& rfv = resize_fill_value ()) const;
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	476
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	477 // Indexed assignment (always with resize & fill).
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	478
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	479 void assign (const idx_vector& i, const Array<T>& rhs,
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	480 const T& rfv = resize_fill_value ());
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	481
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	482 void assign (const idx_vector& i, const idx_vector& j, const Array<T>& rhs,
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	483 const T& rfv = resize_fill_value ());
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	484
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	485 void assign (const Array<idx_vector>& ia, const Array<T>& rhs,
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	486 const T& rfv = resize_fill_value ());
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	487
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	488 // Deleting elements.
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	489
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	490 // A(I) = [] (with a single subscript)
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	491 void delete_elements (const idx_vector& i);
4530 e8d87fefd144 [project @ 2003-10-07 04:02:04 by jwe] jwe parents: 4518 diff changeset	492
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	493 // A(:,...,I,...,:) = [] (>= 2 subscripts, one of them is non-colon)
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	494 void delete_elements (int dim, const idx_vector& i);
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	495
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	496 // Dispatcher to the above two.
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	497 void delete_elements (const Array<idx_vector>& ia);
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	498
10115 ed49cef7e005 simplify Array::insert methods Jaroslav Hajek <highegg@gmail.com> parents: 10095 diff changeset	499 // Insert an array into another at a specified position.
ed49cef7e005 simplify Array::insert methods Jaroslav Hajek <highegg@gmail.com> parents: 10095 diff changeset	500 // If size (a) is [d1 d2 ... dN] and idx is [i1 i2 ... iN],
ed49cef7e005 simplify Array::insert methods Jaroslav Hajek <highegg@gmail.com> parents: 10095 diff changeset	501 // this method is equivalent to
ed49cef7e005 simplify Array::insert methods Jaroslav Hajek <highegg@gmail.com> parents: 10095 diff changeset	502 // x(i1:i1+d1-1, i2:i2+d2-1, ... , iN:iN+dN-1) = a.
ed49cef7e005 simplify Array::insert methods Jaroslav Hajek <highegg@gmail.com> parents: 10095 diff changeset	503 Array<T>& insert (const Array<T>& a, const Array<octave_idx_type>& idx);
3928 e8627dc4bdf2 [project @ 2002-05-03 19:56:01 by jwe] jwe parents: 3836 diff changeset	504
10115 ed49cef7e005 simplify Array::insert methods Jaroslav Hajek <highegg@gmail.com> parents: 10095 diff changeset	505 // This is just a special case for idx = [r c 0 ...]
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	506 Array<T>& insert (const Array<T>& a, octave_idx_type r, octave_idx_type c);
3933 f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3928 diff changeset	507
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	508 void maybe_economize (void)
ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	509 {
ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	510 if (rep->count == 1 && slice_len != rep->len)
ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	511 {
10364 96ed7c629bbd remove dangerous pointer-acquiring Array ctors Jaroslav Hajek <highegg@gmail.com> parents: 10358 diff changeset	512 ArrayRep *new_rep = new ArrayRep (slice_data, slice_len);
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	513 delete rep;
ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	514 rep = new_rep;
ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	515 slice_data = rep->data;
ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	516 }
ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	517 }
ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	518
4517 b4449b1193ac [project @ 2003-09-20 02:06:06 by jwe] jwe parents: 4513 diff changeset	519 void print_info (std::ostream& os, const std::string& prefix) const;
5900 c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe] jwe parents: 5775 diff changeset	520
c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe] jwe parents: 5775 diff changeset	521 // Unsafe. This function exists to support the MEX interface.
c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe] jwe parents: 5775 diff changeset	522 // You should not use it anywhere else.
c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe] jwe parents: 5775 diff changeset	523 void mex_get_data (void) const { return const_cast<T > (data ()); }
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7017 diff changeset	524
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9653 diff changeset	525 Array<T> sort (int dim = 0, sortmode mode = ASCENDING) const;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9653 diff changeset	526 Array<T> sort (Array<octave_idx_type> &sidx, int dim = 0,
10312 cbc402e64d83 untabify liboctave header files John W. Eaton <jwe@octave.org> parents: 10158 diff changeset	527 sortmode mode = ASCENDING) const;
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	528
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8700 diff changeset	529 // Ordering is auto-detected or can be specified.
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8700 diff changeset	530 sortmode is_sorted (sortmode mode = UNSORTED) const;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8700 diff changeset	531
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8700 diff changeset	532 // Sort by rows returns only indices.
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8700 diff changeset	533 Array<octave_idx_type> sort_rows_idx (sortmode mode = ASCENDING) const;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8700 diff changeset	534
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8700 diff changeset	535 // Ordering is auto-detected or can be specified.
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8700 diff changeset	536 sortmode is_sorted_rows (sortmode mode = UNSORTED) const;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8700 diff changeset	537
9921 7c8392a034e6 fix & improve lookup API Jaroslav Hajek <highegg@gmail.com> parents: 9878 diff changeset	538 // Do a binary lookup in a sorted array. Must not contain NaNs.
8814 de16ebeef93d improve lookup, provide Array<T>::lookup Jaroslav Hajek <highegg@gmail.com> parents: 8725 diff changeset	539 // Mode can be specified or is auto-detected by comparing 1st and last element.
de16ebeef93d improve lookup, provide Array<T>::lookup Jaroslav Hajek <highegg@gmail.com> parents: 8725 diff changeset	540 octave_idx_type lookup (const T& value, sortmode mode = UNSORTED) const;
de16ebeef93d improve lookup, provide Array<T>::lookup Jaroslav Hajek <highegg@gmail.com> parents: 8725 diff changeset	541
9921 7c8392a034e6 fix & improve lookup API Jaroslav Hajek <highegg@gmail.com> parents: 9878 diff changeset	542 // Ditto, but for an array of values, specializing on the case when values
7c8392a034e6 fix & improve lookup API Jaroslav Hajek <highegg@gmail.com> parents: 9878 diff changeset	543 // are sorted. NaNs get the value N.
7c8392a034e6 fix & improve lookup API Jaroslav Hajek <highegg@gmail.com> parents: 9878 diff changeset	544 Array<octave_idx_type> lookup (const Array<T>& values, sortmode mode = UNSORTED) const;
9341 9fd5c56ce57a extend lookup capabilities Jaroslav Hajek <highegg@gmail.com> parents: 9201 diff changeset	545
9878 ead4f9c82a9a implement Array<T>::nnz Jaroslav Hajek <highegg@gmail.com> parents: 9840 diff changeset	546 // Count nonzero elements.
ead4f9c82a9a implement Array<T>::nnz Jaroslav Hajek <highegg@gmail.com> parents: 9840 diff changeset	547 octave_idx_type nnz (void) const;
ead4f9c82a9a implement Array<T>::nnz Jaroslav Hajek <highegg@gmail.com> parents: 9840 diff changeset	548
9025 484756d558d6 add Array<T>::find Jaroslav Hajek <highegg@gmail.com> parents: 8998 diff changeset	549 // Find indices of (at most n) nonzero elements. If n is specified, backward
484756d558d6 add Array<T>::find Jaroslav Hajek <highegg@gmail.com> parents: 8998 diff changeset	550 // specifies search from backward.
484756d558d6 add Array<T>::find Jaroslav Hajek <highegg@gmail.com> parents: 8998 diff changeset	551 Array<octave_idx_type> find (octave_idx_type n = -1, bool backward = false) const;
484756d558d6 add Array<T>::find Jaroslav Hajek <highegg@gmail.com> parents: 8998 diff changeset	552
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9653 diff changeset	553 // Returns the n-th element in increasing order, using the same ordering as
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9653 diff changeset	554 // used for sort. n can either be a scalar index or a contiguous range.
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9653 diff changeset	555 Array<T> nth_element (const idx_vector& n, int dim = 0) const;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9653 diff changeset	556
7620 36594d5bbe13 Move diag function into the octave_value class David Bateman <dbateman@free.fr> parents: 7503 diff changeset	557 Array<T> diag (octave_idx_type k = 0) const;
36594d5bbe13 Move diag function into the octave_value class David Bateman <dbateman@free.fr> parents: 7503 diff changeset	558
10716 f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10674 diff changeset	559 // Concatenation along a specified (0-based) dimension, equivalent to cat().
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10674 diff changeset	560 // dim = -1 corresponds to dim = 0 and dim = -2 corresponds to dim = 1,
f7f26094021b improve cat code design in data.cc, make horzcat/vertcat more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10674 diff changeset	561 // but apply the looser matching rules of vertcat/horzcat.
10531 2dd8ea8bfd71 basic cat functionality in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 10521 diff changeset	562 static Array<T>
2dd8ea8bfd71 basic cat functionality in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 10521 diff changeset	563 cat (int dim, octave_idx_type n, const Array<T> *array_list);
2dd8ea8bfd71 basic cat functionality in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 10521 diff changeset	564
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	565 template <class U, class F>
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	566 Array<U>
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	567 map (F fcn) const
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	568 {
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	569 octave_idx_type len = length ();
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	570
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	571 const T *m = data ();
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	572
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	573 Array<U> result (dims ());
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	574 U *p = result.fortran_vec ();
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	575
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	576 octave_idx_type i;
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	577 for (i = 0; i < len - 3; i += 4)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	578 {
10312 cbc402e64d83 untabify liboctave header files John W. Eaton <jwe@octave.org> parents: 10158 diff changeset	579 octave_quit ();
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	580
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	581 p[i] = fcn (m[i]);
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	582 p[i+1] = fcn (m[i+1]);
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	583 p[i+2] = fcn (m[i+2]);
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	584 p[i+3] = fcn (m[i+3]);
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	585 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	586
10142 829e69ec3110 make OCTAVE_QUIT a function Jaroslav Hajek <highegg@gmail.com> parents: 10115 diff changeset	587 octave_quit ();
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	588
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	589 for (; i < len; i++)
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	590 p[i] = fcn (m[i]);
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	591
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	592 return result;
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	593 }
8998 a48fba01e4ac optimize isnan/isinf/isfinite mappers Jaroslav Hajek <highegg@gmail.com> parents: 8950 diff changeset	594
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	595 // Overloads for function references.
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	596 template <class U>
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	597 Array<U>
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	598 map (U (&fcn) (T)) const
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	599 { return map<U, U (&) (T)> (fcn); }
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	600
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	601 template <class U>
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	602 Array<U>
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	603 map (U (&fcn) (const T&)) const
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	604 { return map<U, U (&) (const T&)> (fcn); }
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	605
11010 9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	606 // Generic any/all test functionality with arbitrary predicate.
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	607 template <class F, bool zero>
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	608 bool test (F fcn) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	609 {
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	610 octave_idx_type len = length ();
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	611
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	612 const T *m = data ();
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	613
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	614 octave_idx_type i;
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	615 for (i = 0; i < len - 3; i += 4)
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	616 {
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	617 octave_quit ();
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	618
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	619 if (fcn (m[i]) != zero
11010 9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	620 \|\| fcn (m[i+1]) != zero
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	621 \|\| fcn (m[i+2]) != zero
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	622 \|\| fcn (m[i+3]) != zero)
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	623 return ! zero;
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	624
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	625 }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	626
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	627 octave_quit ();
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	628
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	629 for (; i < len; i++)
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	630 if (fcn (m[i]) != zero)
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	631 return ! zero;
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	632
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	633 return zero;
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	634 }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	635
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	636 // Simpler calls.
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	637 template <class F>
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	638 bool test_any (F fcn) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	639 { return test<F, false> (fcn); }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	640
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	641 template <class F>
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	642 bool test_all (F fcn) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	643 { return test<F, true> (fcn); }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	644
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	645 // Overloads for function references.
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	646 bool test_any (bool (&fcn) (T)) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	647 { return test<bool (&) (T), false> (fcn); }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	648
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	649 bool test_any (bool (&fcn) (const T&)) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	650 { return test<bool (&) (const T&), false> (fcn); }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	651
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	652 bool test_all (bool (&fcn) (T)) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	653 { return test<bool (&) (T), true> (fcn); }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	654
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	655 bool test_all (bool (&fcn) (const T&)) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	656 { return test<bool (&) (const T&), true> (fcn); }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	657
9046 88bf56bbccca make Array::find already return Matlab-compatible dimensions Jaroslav Hajek <highegg@gmail.com> parents: 9026 diff changeset	658 template <class U> friend class Array;
9201 472f0e22aa60 guard against implicit instantiation Jaroslav Hajek <highegg@gmail.com> parents: 9046 diff changeset	659
10674 e3064439d6b4 new Array method for internal use Jaroslav Hajek <highegg@gmail.com> parents: 10673 diff changeset	660 // Returns true if this->dims () == dv, and if so, replaces this->dimensions
e3064439d6b4 new Array method for internal use Jaroslav Hajek <highegg@gmail.com> parents: 10673 diff changeset	661 // by a shallow copy of dv. This is useful for maintaining several arrays with
e3064439d6b4 new Array method for internal use Jaroslav Hajek <highegg@gmail.com> parents: 10673 diff changeset	662 // supposedly equal dimensions (e.g. structs in the interpreter).
e3064439d6b4 new Array method for internal use Jaroslav Hajek <highegg@gmail.com> parents: 10673 diff changeset	663 bool optimize_dimensions (const dim_vector& dv);
e3064439d6b4 new Array method for internal use Jaroslav Hajek <highegg@gmail.com> parents: 10673 diff changeset	664
9201 472f0e22aa60 guard against implicit instantiation Jaroslav Hajek <highegg@gmail.com> parents: 9046 diff changeset	665 private:
11574 a83bad07f7e3 attempt better backward compatibility for Array resize functions John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	666
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	667 void resize2 (octave_idx_type nr, octave_idx_type nc,
11574 a83bad07f7e3 attempt better backward compatibility for Array resize functions John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	668 const T& rfv = resize_fill_value ());
a83bad07f7e3 attempt better backward compatibility for Array resize functions John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	669
9201 472f0e22aa60 guard against implicit instantiation Jaroslav Hajek <highegg@gmail.com> parents: 9046 diff changeset	670 static void instantiation_guard ();
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	671 };
4459 75ee1995d2b4 [project @ 2003-07-11 17:46:41 by jwe] jwe parents: 4192 diff changeset	672
9653 e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	673 // This is a simple wrapper template that will subclass an Array<T> type or any
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	674 // later type derived from it and override the default non-const operator() to
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	675 // not check for the array's uniqueness. It is, however, the user's
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	676 // responsibility to ensure the array is actually unaliased whenever elements
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	677 // are accessed.
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	678
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	679 template<class ArrayClass>
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	680 class NoAlias : public ArrayClass
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	681 {
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	682 typedef typename ArrayClass::element_type T;
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	683 public:
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	684 NoAlias () : ArrayClass () { }
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	685
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	686 // FIXME: this would be simpler once C++0x is available
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	687 template <class X>
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	688 explicit NoAlias (X x) : ArrayClass (x) { }
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	689
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	690 template <class X, class Y>
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	691 explicit NoAlias (X x, Y y) : ArrayClass (x, y) { }
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	692
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	693 template <class X, class Y, class Z>
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	694 explicit NoAlias (X x, Y y, Z z) : ArrayClass (x, y, z) { }
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	695
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	696 T& operator () (octave_idx_type n)
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	697 { return ArrayClass::xelem (n); }
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	698 T& operator () (octave_idx_type i, octave_idx_type j)
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	699 { return ArrayClass::xelem (i, j); }
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	700 T& operator () (octave_idx_type i, octave_idx_type j, octave_idx_type k)
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	701 { return ArrayClass::xelem (i, j, k); }
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	702 T& operator () (const Array<octave_idx_type>& ra_idx)
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	703 { return ArrayClass::xelem (ra_idx); }
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	704 };
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	705
9732 b4fdfee405b5 remove ArrayN<T> + fix nonhom. diag-scalar ops Jaroslav Hajek <highegg@gmail.com> parents: 9731 diff changeset	706 template <class T>
b4fdfee405b5 remove ArrayN<T> + fix nonhom. diag-scalar ops Jaroslav Hajek <highegg@gmail.com> parents: 9731 diff changeset	707 std::ostream&
b4fdfee405b5 remove ArrayN<T> + fix nonhom. diag-scalar ops Jaroslav Hajek <highegg@gmail.com> parents: 9731 diff changeset	708 operator << (std::ostream& os, const Array<T>& a);
b4fdfee405b5 remove ArrayN<T> + fix nonhom. diag-scalar ops Jaroslav Hajek <highegg@gmail.com> parents: 9731 diff changeset	709
9773 01f897d8a130 optimize memory manipulation by arrays & indexing Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	710 #endif

Mercurial > octave-dspies

annotate liboctave/Array.h @ 12125:a21a3875ca83