octave: liboctave/array/Array.h annotate

annotate liboctave/array/Array.h @ 23220:092078913d54

maint: Merge stable to default.

author	John W. Eaton <jwe@octave.org>
date	Wed, 22 Feb 2017 12:58:07 -0500
parents	ef4d915df748 3ac9f9ecfae5
children	f1ea44e92df8

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
23219 3ac9f9ecfae5 maint: Update copyright dates. John W. Eaton <jwe@octave.org> parents: 23083 diff changeset	4 Copyright (C) 1993-2017 John W. Eaton
11523 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
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	11 under the terms of the GNU General Public License as published by
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	12 the Free Software Foundation; either version 3 of the License, or
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	13 (at your option) any later version.
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	14
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	15 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	16 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	18 GNU General Public License for more details.
228 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
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 20232 diff changeset	26 #if ! defined (octave_Array_h)
382 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
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21229 diff changeset	29 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21229 diff changeset	30
1366 f75432dff006 [project @ 1995-09-05 23:56:42 by jwe] jwe parents: 1359 diff changeset	31 #include <cassert>
4152 f14251d33b01 [project @ 2002-11-06 18:41:50 by jwe] jwe parents: 4066 diff changeset	32 #include <cstddef>
3613 0a93682f89c8 [project @ 2000-03-17 10:58:25 by jwe] jwe parents: 3585 diff changeset	33
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	34 #include <algorithm>
8950 d865363208d6 include <iosfwd> instead of <iostream> in header files John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	35 #include <iosfwd>
3933 f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3928 diff changeset	36
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	37 #include "dim-vector.h"
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	38 #include "idx-vector.h"
22139 f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	39 #include "lo-error.h"
8725 d5af326a3ede [mq]: sort-traits John W. Eaton <jwe@octave.org> parents: 8721 diff changeset	40 #include "lo-traits.h"
3613 0a93682f89c8 [project @ 2000-03-17 10:58:25 by jwe] jwe parents: 3585 diff changeset	41 #include "lo-utils.h"
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7017 diff changeset	42 #include "oct-sort.h"
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	43 #include "quit.h"
12125 a21a3875ca83 implement a common class for reference counts Jaroslav Hajek <highegg@gmail.com> parents: 11586 diff changeset	44 #include "oct-refcount.h"
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7017 diff changeset	45
22273 91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	46 //! N Dimensional Array with copy-on-write semantics.
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	47 /*!
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	48 The Array class is at the root of Octave. It provides a container
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	49 with an arbitrary number of dimensions. The operator () provides
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	50 access to individual elements via subscript and linear indexing.
22276 dd0d2a27e5b3 doc: fix indexing note on doxygen docs for Array<T>. Carnë Draug <carandraug@octave.org> parents: 22273 diff changeset	51 Indexing starts at 0. Arrays are column-major order as in Fortran.
22273 91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	52
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	53 @code{.cc}
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	54 // 3 D Array with 10 rows, 20 columns, and 5 pages, filled with 7.0
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	55 Array<double> A Array<double (dim_vector (10, 20, 5), 7.0);
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	56
22276 dd0d2a27e5b3 doc: fix indexing note on doxygen docs for Array<T>. Carnë Draug <carandraug@octave.org> parents: 22273 diff changeset	57 // set value for row 0, column 10, and page 3
dd0d2a27e5b3 doc: fix indexing note on doxygen docs for Array<T>. Carnë Draug <carandraug@octave.org> parents: 22273 diff changeset	58 A(0, 10, 3) = 2.5;
22273 91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	59
22276 dd0d2a27e5b3 doc: fix indexing note on doxygen docs for Array<T>. Carnë Draug <carandraug@octave.org> parents: 22273 diff changeset	60 // get value for row 1, column 2, and page 0
dd0d2a27e5b3 doc: fix indexing note on doxygen docs for Array<T>. Carnë Draug <carandraug@octave.org> parents: 22273 diff changeset	61 double v = A(1, 2, 0);
22273 91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	62
22276 dd0d2a27e5b3 doc: fix indexing note on doxygen docs for Array<T>. Carnë Draug <carandraug@octave.org> parents: 22273 diff changeset	63 // get value for 25th element (row 4, column 3, page 1)
22273 91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	64 double v = A(24);
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	65 @endcode
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	66
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	67 ## Notes on STL compatibility
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	68
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	69 ### size() and length()
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	70
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	71 To access the total number of elements in an Array, use numel()
22279 3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	72 which is short for number of elements and is equivalent to the
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	73 Octave function with same name.
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	74
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	75 @code{.cc}
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	76 Array<int> A (dim_vector (10, 20, 4), 1);
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	77
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	78 octave_idx_type n = A.numel (); // returns 800 (10x20x4)
22273 91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	79
22279 3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	80 octave_idx_type nr = A.size (0); // returns 10 (number of rows/dimension 0)
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	81 octave_idx_type nc = A.size (1); // returns 20 (number of columns)
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	82 octave_idx_type nc = A.size (2); // returns 4 (size of dimension 3)
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	83 octave_idx_type l6 = A.size (6); // returns 1 (implicit singleton dimension)
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	84
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	85 // Alternatively, get a dim_vector which represents the dimensions.
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	86 dim_vector dims = A.dims ();
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	87 @endcode
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	88
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	89 The methods size() and length() as they exist in the STL cause
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	90 confusion in the context of a N dimensional array.
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	91
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	92 The size() of an array is the length of all dimensions. In Octave,
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	93 the size() function returns a row vector with the length of each
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	94 dimension, or the size of a specific dimension. Only the latter is
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	95 present in liboctave.
22273 91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	96
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	97 Since there is more than 1 dimension, length() would not make sense
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	98 without expliciting which dimension. If the function existed, which
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	99 length should it return? Octave length() function returns the length
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	100 of the longest dimension which is an odd definition, only useful for
22279 3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	101 vectors and square matrices. The alternatives numel(), rows(),
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	102 columns(), and size(d) are more explict and recommended.
22273 91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	103
22279 3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	104 ### size_type
22273 91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	105
22279 3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	106 Array::size_type is `octave_idx_type` which is a typedef for `int`
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	107 or `long int`, depending whether Octave was configured for 64-bit
22273 91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	108 indexing.
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	109
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	110 This is a signed integer which may cause problems when mixed with
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	111 STL containers. The reason is that Octave interacts with Fortran
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	112 routines, providing an interface many Fortran numeric libraries.
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	113
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	114 ## Subclasses
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	115
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	116 The following subclasses specializations, will be of most use:
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	117 - Matrix: Array<double> with only 2 dimensions
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	118 - ComplexMatrix: Array<std::complex<double>> with only 2 dimensions
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	119 - boolNDArray: N dimensional Array<bool>
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	120 - ColumnVector: Array<double> with 1 column
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	121 - string_vector: Array<std::string> with 1 column
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	122 - Cell: Array<octave_value>, equivalent to an Octave cell.
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	123
91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	124 */
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	125 template <typename T>
3585 d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3569 diff changeset	126 class
d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3569 diff changeset	127 Array
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	128 {
3504 5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe] jwe parents: 2847 diff changeset	129 protected:
1619 1a35c8c91349 [project @ 1995-11-04 11:07:21 by jwe] jwe parents: 1574 diff changeset	130
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	131 //! The real representation of all arrays.
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	132 class ArrayRep
d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	133 {
d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	134 public:
d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	135
d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	136 T *data;
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	137 octave_idx_type len;
23012 27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	138 octave::refcount<int> count;
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	139
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	140 ArrayRep (T *d, octave_idx_type l)
19381 af41e41ad28e replace oct-mem.h inline indirections by standard function calls. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19330 diff changeset	141 : data (new T [l]), len (l), count (1)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	142 {
19381 af41e41ad28e replace oct-mem.h inline indirections by standard function calls. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19330 diff changeset	143 std::copy (d, d+l, data);
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	144 }
10364 96ed7c629bbd remove dangerous pointer-acquiring Array ctors Jaroslav Hajek <highegg@gmail.com> parents: 10358 diff changeset	145
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	146 template <typename U>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	147 ArrayRep (U *d, octave_idx_type l)
19381 af41e41ad28e replace oct-mem.h inline indirections by standard function calls. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19330 diff changeset	148 : data (new T [l]), len (l), count (1)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	149 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	150 std::copy (d, d+l, data);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	151 }
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	152
d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	153 ArrayRep (void) : data (0), len (0), count (1) { }
d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	154
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	155 explicit ArrayRep (octave_idx_type n)
19381 af41e41ad28e replace oct-mem.h inline indirections by standard function calls. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19330 diff changeset	156 : data (new T [n]), len (n), count (1) { }
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	157
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	158 explicit ArrayRep (octave_idx_type n, const T& val)
19381 af41e41ad28e replace oct-mem.h inline indirections by standard function calls. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19330 diff changeset	159 : data (new T [n]), len (n), count (1)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	160 {
19381 af41e41ad28e replace oct-mem.h inline indirections by standard function calls. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19330 diff changeset	161 std::fill_n (data, n, val);
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	162 }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	163
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	164 ArrayRep (const ArrayRep& a)
19381 af41e41ad28e replace oct-mem.h inline indirections by standard function calls. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19330 diff changeset	165 : data (new T [a.len]), len (a.len), count (1)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	166 {
19381 af41e41ad28e replace oct-mem.h inline indirections by standard function calls. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19330 diff changeset	167 std::copy (a.data, a.data + a.len, data);
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	168 }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	169
19381 af41e41ad28e replace oct-mem.h inline indirections by standard function calls. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19330 diff changeset	170 ~ArrayRep (void) { delete [] data; }
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	171
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20229 diff changeset	172 octave_idx_type numel (void) const { return len; }
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	173
4517 b4449b1193ac [project @ 2003-09-20 02:06:06 by jwe] jwe parents: 4513 diff changeset	174 private:
b4449b1193ac [project @ 2003-09-20 02:06:06 by jwe] jwe parents: 4513 diff changeset	175
b4449b1193ac [project @ 2003-09-20 02:06:06 by jwe] jwe parents: 4513 diff changeset	176 // No assignment!
b4449b1193ac [project @ 2003-09-20 02:06:06 by jwe] jwe parents: 4513 diff changeset	177
b4449b1193ac [project @ 2003-09-20 02:06:06 by jwe] jwe parents: 4513 diff changeset	178 ArrayRep& operator = (const ArrayRep& a);
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	179 };
d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	180
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	181 //--------------------------------------------------------------------
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	182
6884 1cbb8b606d63 [project @ 2007-09-10 20:43:26 by jwe] jwe parents: 6881 diff changeset	183 public:
1cbb8b606d63 [project @ 2007-09-10 20:43:26 by jwe] jwe parents: 6881 diff changeset	184
9556 948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	185 void make_unique (void)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	186 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	187 if (rep->count > 1)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	188 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	189 ArrayRep *r = new ArrayRep (slice_data, slice_len);
13985 43cc49c7abd1 Use thread-safe atomic reference counting (GCC and MSVC). Michael Goffioul <michael.goffioul@gmail.com> parents: 12125 diff changeset	190
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	191 if (--rep->count == 0)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	192 delete rep;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	193
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	194 rep = r;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	195 slice_data = rep->data;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	196 }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	197 }
238 780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe] jwe parents: 228 diff changeset	198
5900 c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe] jwe parents: 5775 diff changeset	199 typedef T element_type;
c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe] jwe parents: 5775 diff changeset	200
22279 3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	201 typedef T value_type;
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	202
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	203 //! Used for operator(), and returned by numel() and size()
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	204 //! (beware: signed integer)
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	205 typedef octave_idx_type size_type;
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	206
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	207 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	208
8725 d5af326a3ede [mq]: sort-traits John W. Eaton <jwe@octave.org> parents: 8721 diff changeset	209 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	210 typename ref_param<T>::type);
8725 d5af326a3ede [mq]: sort-traits John W. Eaton <jwe@octave.org> parents: 8721 diff changeset	211
8524 937921654627 clean up Array and DiagArray2 Jaroslav Hajek <highegg@gmail.com> parents: 8523 diff changeset	212 protected:
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: 4834 diff changeset	213
11507 c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	214 dim_vector dimensions;
4518 382cb0ed8c14 [project @ 2003-09-20 18:08:40 by jwe] jwe parents: 4517 diff changeset	215
11507 c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	216 typename Array<T>::ArrayRep *rep;
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	217
8531 b01fef323c24 add some explaining comments Jaroslav Hajek <highegg@gmail.com> parents: 8524 diff changeset	218 // Rationale:
b01fef323c24 add some explaining comments Jaroslav Hajek <highegg@gmail.com> parents: 8524 diff changeset	219 // slice_data is a pointer to rep->data, denoting together with slice_len the
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	220 // actual portion of the data referenced by this Array<T> object. This
b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	221 // allows to make shallow copies not only of a whole array, but also of
b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	222 // contiguous subranges. Every time rep is directly manipulated, slice_data
b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	223 // and slice_len need to be properly updated.
8531 b01fef323c24 add some explaining comments Jaroslav Hajek <highegg@gmail.com> parents: 8524 diff changeset	224
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	225 T* slice_data;
ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	226 octave_idx_type slice_len;
ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	227
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	228 //! slice constructor
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	229 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	230 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	231 : dimensions (dv), rep(a.rep), slice_data (a.slice_data+l), slice_len (u-l)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	232 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	233 rep->count++;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	234 dimensions.chop_trailing_singletons ();
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	235 }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	236
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	237 private:
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	238
21573 f3f8e1d3e399 avoid mulitple definitions of static function-scope vars (bug #47372) John W. Eaton <jwe@octave.org> parents: 20212 diff changeset	239 static typename Array<T>::ArrayRep *nil_rep (void);
238 780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe] jwe parents: 228 diff changeset	240
14951 4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	241 protected:
4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	242
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	243 //! For jit support
14951 4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	244 Array (T sdata, octave_idx_type slen, octave_idx_type adims, void *arep)
4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	245 : dimensions (adims),
4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	246 rep (reinterpret_cast<typename Array<T>::ArrayRep *> (arep)),
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	247 slice_data (sdata), slice_len (slen) { }
14951 4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	248
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	249 public:
238 780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe] jwe parents: 228 diff changeset	250
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	251 //! Empty ctor (0 by 0).
1550 d89532de8e72 [project @ 1995-10-08 01:12:20 by jwe] jwe parents: 1366 diff changeset	252 Array (void)
11507 c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	253 : 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	254 slice_len (rep->len)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	255 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	256 rep->count++;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	257 }
1550 d89532de8e72 [project @ 1995-10-08 01:12:20 by jwe] jwe parents: 1366 diff changeset	258
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	259 //! nD uninitialized ctor.
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	260 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	261 : dimensions (dv),
c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	262 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	263 slice_data (rep->data), slice_len (rep->len)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	264 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	265 dimensions.chop_trailing_singletons ();
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	266 }
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	267
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	268 //! nD initialized ctor.
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	269 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	270 : dimensions (dv),
c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	271 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	272 slice_data (rep->data), slice_len (rep->len)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	273 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	274 fill (val);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	275 dimensions.chop_trailing_singletons ();
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	276 }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	277
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	278 //! Reshape constructor.
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	279 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	280
22139 f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	281 //! Constructor from standard library sequence containers.
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	282 template<template <typename...> class Container>
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	283 Array (const Container<T>& a, const dim_vector& dv);
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	284
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	285 //! Type conversion case.
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	286 template <typename U>
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: 4834 diff changeset	287 Array (const Array<U>& a)
11507 c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	288 : dimensions (a.dims ()),
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20229 diff changeset	289 rep (new typename Array<T>::ArrayRep (a.data (), a.numel ())),
11507 c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	290 slice_data (rep->data), slice_len (rep->len)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	291 { }
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: 4834 diff changeset	292
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	293 //! No type conversion case.
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	294 Array (const Array<T>& a)
11507 c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	295 : 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	296 slice_len (a.slice_len)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	297 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	298 rep->count++;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	299 }
1550 d89532de8e72 [project @ 1995-10-08 01:12:20 by jwe] jwe parents: 1366 diff changeset	300
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	301 public:
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	302
15216 dd7c37ceb800 avoid GCC warning by declaring Array destructor virtual John W. Eaton <jwe@octave.org> parents: 15212 diff changeset	303 virtual ~Array (void)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	304 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	305 if (--rep->count == 0)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	306 delete rep;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	307 }
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	308
9556 948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	309 Array<T>& operator = (const Array<T>& a)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	310 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	311 if (this != &a)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	312 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	313 if (--rep->count == 0)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	314 delete rep;
9556 948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	315
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	316 rep = a.rep;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	317 rep->count++;
9556 948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	318
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	319 dimensions = a.dimensions;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	320 slice_data = a.slice_data;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	321 slice_len = a.slice_len;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	322 }
9556 948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	323
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	324 return *this;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	325 }
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 void fill (const T& val);
9624 3fc7272937ce implement Array<T>::clear overloads Jaroslav Hajek <highegg@gmail.com> parents: 9556 diff changeset	328
9546 1beb23d2b892 optimize op= in common cases Jaroslav Hajek <highegg@gmail.com> parents: 9341 diff changeset	329 void clear (void);
9624 3fc7272937ce implement Array<T>::clear overloads Jaroslav Hajek <highegg@gmail.com> parents: 9556 diff changeset	330 void clear (const dim_vector& dv);
3fc7272937ce implement Array<T>::clear overloads Jaroslav Hajek <highegg@gmail.com> parents: 9556 diff changeset	331
3fc7272937ce implement Array<T>::clear overloads Jaroslav Hajek <highegg@gmail.com> parents: 9556 diff changeset	332 void clear (octave_idx_type r, octave_idx_type c)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	333 { clear (dim_vector (r, c)); }
238 780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe] jwe parents: 228 diff changeset	334
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	335 // Number of elements in the array. These are all synonyms.
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	336 //@{
20212 6af35d4f1ba4 doxygen: document Array::length() and similar methods (bug #45138) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	337 //! Number of elements in the array.
20228 00cf2847355d Deprecate Array::nelem() and Range::nelem() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20212 diff changeset	338 //! Synonymous with numel().
20229 5dfaaaae784f Deprecate Array::capacity() and Sparse::capacity() for numel() and nzmax(). Carnë Draug <carandraug@octave.org> parents: 20228 diff changeset	339 //! @note This method is deprecated in favour of numel().
21134 2e5c1f766ac9 provide replacement hints for deprecated C++ functions John W. Eaton <jwe@octave.org> parents: 21131 diff changeset	340 OCTAVE_DEPRECATED ("use 'numel' instead")
2e5c1f766ac9 provide replacement hints for deprecated C++ functions John W. Eaton <jwe@octave.org> parents: 21131 diff changeset	341 octave_idx_type capacity (void) const { return numel (); }
20212 6af35d4f1ba4 doxygen: document Array::length() and similar methods (bug #45138) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	342
6af35d4f1ba4 doxygen: document Array::length() and similar methods (bug #45138) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	343 //! Number of elements in the array.
20229 5dfaaaae784f Deprecate Array::capacity() and Sparse::capacity() for numel() and nzmax(). Carnë Draug <carandraug@octave.org> parents: 20228 diff changeset	344 /*! Synonymous with numel().
20228 00cf2847355d Deprecate Array::nelem() and Range::nelem() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20212 diff changeset	345 @note This method is deprecated in favour of numel().
20212 6af35d4f1ba4 doxygen: document Array::length() and similar methods (bug #45138) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	346
6af35d4f1ba4 doxygen: document Array::length() and similar methods (bug #45138) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	347 @note
6af35d4f1ba4 doxygen: document Array::length() and similar methods (bug #45138) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	348 This is @em not the same as @c %length() at the Octave interpreter.
6af35d4f1ba4 doxygen: document Array::length() and similar methods (bug #45138) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	349 At the Octave interpreter, the function @c %length() returns the
6af35d4f1ba4 doxygen: document Array::length() and similar methods (bug #45138) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	350 length of the greatest dimension. This method returns the total
6af35d4f1ba4 doxygen: document Array::length() and similar methods (bug #45138) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	351 number of elements.
6af35d4f1ba4 doxygen: document Array::length() and similar methods (bug #45138) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	352 */
21134 2e5c1f766ac9 provide replacement hints for deprecated C++ functions John W. Eaton <jwe@octave.org> parents: 21131 diff changeset	353 OCTAVE_DEPRECATED ("use 'numel' instead")
2e5c1f766ac9 provide replacement hints for deprecated C++ functions John W. Eaton <jwe@octave.org> parents: 21131 diff changeset	354 octave_idx_type length (void) const { return numel (); }
20212 6af35d4f1ba4 doxygen: document Array::length() and similar methods (bug #45138) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	355
6af35d4f1ba4 doxygen: document Array::length() and similar methods (bug #45138) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	356 //! Number of elements in the array.
20229 5dfaaaae784f Deprecate Array::capacity() and Sparse::capacity() for numel() and nzmax(). Carnë Draug <carandraug@octave.org> parents: 20228 diff changeset	357 //! Synonymous with numel().
20228 00cf2847355d Deprecate Array::nelem() and Range::nelem() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20212 diff changeset	358 //! @note This method is deprecated in favour of numel().
21134 2e5c1f766ac9 provide replacement hints for deprecated C++ functions John W. Eaton <jwe@octave.org> parents: 21131 diff changeset	359 OCTAVE_DEPRECATED ("use 'numel' instead")
2e5c1f766ac9 provide replacement hints for deprecated C++ functions John W. Eaton <jwe@octave.org> parents: 21131 diff changeset	360 octave_idx_type nelem (void) const { return numel (); }
20212 6af35d4f1ba4 doxygen: document Array::length() and similar methods (bug #45138) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	361
6af35d4f1ba4 doxygen: document Array::length() and similar methods (bug #45138) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	362 //! Number of elements in the array.
20228 00cf2847355d Deprecate Array::nelem() and Range::nelem() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20212 diff changeset	363 octave_idx_type numel (void) const { return slice_len; }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	364 //@}
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	365
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	366 //! Return the array as a column vector.
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	367 Array<T> as_column (void) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	368 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	369 Array<T> retval (*this);
21660 53728df3e4c9 maint: for clarity, call ndims() rather than length() on dimension vectors. Rik <rik@octave.org> parents: 21574 diff changeset	370 if (dimensions.ndims () != 2 \|\| dimensions(1) != 1)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	371 retval.dimensions = dim_vector (numel (), 1);
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	372
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	373 return retval;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	374 }
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	375
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	376 //! Return the array as a row vector.
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	377 Array<T> as_row (void) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	378 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	379 Array<T> retval (*this);
21660 53728df3e4c9 maint: for clarity, call ndims() rather than length() on dimension vectors. Rik <rik@octave.org> parents: 21574 diff changeset	380 if (dimensions.ndims () != 2 \|\| dimensions(0) != 1)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	381 retval.dimensions = dim_vector (1, numel ());
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	382
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	383 return retval;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	384 }
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	385
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	386 //! Return the array as a matrix.
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	387 Array<T> as_matrix (void) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	388 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	389 Array<T> retval (*this);
21660 53728df3e4c9 maint: for clarity, call ndims() rather than length() on dimension vectors. Rik <rik@octave.org> parents: 21574 diff changeset	390 if (dimensions.ndims () != 2)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	391 retval.dimensions = dimensions.redim (2);
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	392
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	393 return retval;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	394 }
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	395
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	396 //! @name First dimension
19330 1f4455ff2329 Remove deprecated methods in liboctave. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19326 diff changeset	397 //!
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	398 //! Get the first dimension of the array (number of rows)
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	399 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	400 octave_idx_type dim1 (void) const { return dimensions(0); }
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	401 octave_idx_type rows (void) const { return dim1 (); }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	402 //@}
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	403
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	404 //! @name Second dimension
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	405 //!
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	406 //! Get the second dimension of the array (number of columns)
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	407 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	408 octave_idx_type dim2 (void) const { return dimensions(1); }
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	409 octave_idx_type cols (void) const { return dim2 (); }
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	410 octave_idx_type columns (void) const { return dim2 (); }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	411 //@}
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	412
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	413 //! @name Third dimension
19330 1f4455ff2329 Remove deprecated methods in liboctave. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19326 diff changeset	414 //!
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	415 //! Get the third dimension of the array (number of pages)
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	416 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	417 octave_idx_type dim3 (void) const { return dimensions(2); }
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	418 octave_idx_type pages (void) const { return dim3 (); }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	419 //@}
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	420
22279 3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	421 //! Size of the specified dimension.
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	422 /*!
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	423 Dimensions beyond the Array number of dimensions return 1 as
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	424 those are implicit singleton dimensions.
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	425
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	426 Equivalent to Octave's `size (A, DIM)`
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	427 */
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	428 size_type size (const size_type d) const
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	429 {
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	430 // Should we throw for negative values?
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	431 // Should >= ndims () be handled by dim_vector operator() instead ?
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	432 return d >= ndims () ? 1 : dimensions(d);
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	433 }
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	434
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	435 size_t byte_size (void) const
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	436 { return static_cast<size_t> (numel ()) * sizeof (T); }
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: 4834 diff changeset	437
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	438 //! Return a const-reference so that dims ()(i) works efficiently.
9026 6890d411a0b8 adjust some array dim query methods Jaroslav Hajek <highegg@gmail.com> parents: 9025 diff changeset	439 const dim_vector& dims (void) const { return dimensions; }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	440
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	441 //! Chop off leading singleton dimensions
4532 01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4530 diff changeset	442 Array<T> squeeze (void) const;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	443
10366 e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	444 octave_idx_type compute_index (octave_idx_type i, octave_idx_type j) const;
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	445 octave_idx_type compute_index (octave_idx_type i, octave_idx_type j,
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	446 octave_idx_type k) const;
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	447 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	448
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	449 octave_idx_type compute_index_unchecked (const Array<octave_idx_type>& ra_idx)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	450 const
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20229 diff changeset	451 { return dimensions.compute_index (ra_idx.data (), ra_idx.numel ()); }
10645 8645b7087859 abstract scalar index checking off Array<T> (prep for struct optimizations) Jaroslav Hajek <highegg@gmail.com> parents: 10636 diff changeset	452
2108 2b67abb63030 [project @ 1996-04-30 10:44:17 by jwe] jwe parents: 2049 diff changeset	453 // No checking, even for multiple references, ever.
2b67abb63030 [project @ 1996-04-30 10:44:17 by jwe] jwe parents: 2049 diff changeset	454
15018 3d8ace26c5b4 maint: Use Octave coding conventions for cuddled parentheses in liboctave/. Rik <rik@octave.org> parents: 14981 diff changeset	455 T& xelem (octave_idx_type n) { return slice_data[n]; }
3d8ace26c5b4 maint: Use Octave coding conventions for cuddled parentheses in liboctave/. Rik <rik@octave.org> parents: 14981 diff changeset	456 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	457
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	458 T& xelem (octave_idx_type i, octave_idx_type j)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	459 { return xelem (dim1 ()*j+i); }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	460 crefT xelem (octave_idx_type i, octave_idx_type j) const
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	461 { return xelem (dim1 ()*j+i); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	462
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	463 T& xelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	464 { return xelem (i, dim2 ()*k+j); }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	465 crefT xelem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	466 { return xelem (i, dim2 ()*k+j); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	467
6867 83619ae96c1d [project @ 2007-09-06 12:08:44 by dbateman] dbateman parents: 6708 diff changeset	468 T& xelem (const Array<octave_idx_type>& ra_idx)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	469 { return xelem (compute_index_unchecked (ra_idx)); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	470
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	471 crefT xelem (const Array<octave_idx_type>& ra_idx) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	472 { return xelem (compute_index_unchecked (ra_idx)); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	473
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	474 // FIXME: would be nice to fix this so that we don't unnecessarily force
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	475 // a copy, but that is not so easy, and I see no clean way to do it.
2006 95e952f72d66 [project @ 1996-03-04 00:33:32 by jwe] jwe parents: 2005 diff changeset	476
10366 e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	477 T& checkelem (octave_idx_type n);
e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	478 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	479 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	480 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	481
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	482 T& elem (octave_idx_type n)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	483 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	484 make_unique ();
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	485 return xelem (n);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	486 }
2306 2fbf9bb1cd7a [project @ 1996-07-09 16:49:03 by jwe] jwe parents: 2109 diff changeset	487
14846 460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists. Rik <octave@nomad.inbox5.com> parents: 14616 diff changeset	488 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	489
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	490 T& elem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	491 { return elem (i, dim2 ()*k+j); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	492
6867 83619ae96c1d [project @ 2007-09-06 12:08:44 by dbateman] dbateman parents: 6708 diff changeset	493 T& elem (const Array<octave_idx_type>& ra_idx)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	494 { 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	495
21229 a83e7a384ee0 create and install a subset of config.h in octave-config.h John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	496 #if defined (OCTAVE_ENABLE_BOUNDS_CHECK)
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	497 T& operator () (octave_idx_type n) { return checkelem (n); }
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	498 T& operator () (octave_idx_type i, octave_idx_type j)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	499 { return checkelem (i, j); }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	500 T& operator () (octave_idx_type i, octave_idx_type j, octave_idx_type k)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	501 { return checkelem (i, j, k); }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	502 T& operator () (const Array<octave_idx_type>& ra_idx)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	503 { return checkelem (ra_idx); }
2306 2fbf9bb1cd7a [project @ 1996-07-09 16:49:03 by jwe] jwe parents: 2109 diff changeset	504 #else
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	505 T& operator () (octave_idx_type n) { return elem (n); }
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	506 T& operator () (octave_idx_type i, octave_idx_type j) { return elem (i, j); }
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	507 T& operator () (octave_idx_type i, octave_idx_type j, octave_idx_type k)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	508 { return elem (i, j, k); }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	509 T& operator () (const Array<octave_idx_type>& ra_idx)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	510 { return elem (ra_idx); }
2006 95e952f72d66 [project @ 1996-03-04 00:33:32 by jwe] jwe parents: 2005 diff changeset	511 #endif
95e952f72d66 [project @ 1996-03-04 00:33:32 by jwe] jwe parents: 2005 diff changeset	512
10366 e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	513 crefT checkelem (octave_idx_type n) const;
e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	514 crefT checkelem (octave_idx_type i, octave_idx_type j) const;
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	515 crefT checkelem (octave_idx_type i, octave_idx_type j,
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	516 octave_idx_type k) const;
10366 e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	517 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	518
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	519 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	520
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	521 crefT elem (octave_idx_type i, octave_idx_type j) const
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	522 { return xelem (i, j); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	523
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	524 crefT elem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	525 { return xelem (i, j, k); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	526
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	527 crefT elem (const Array<octave_idx_type>& ra_idx) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	528 { 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	529
21229 a83e7a384ee0 create and install a subset of config.h in octave-config.h John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	530 #if defined (OCTAVE_ENABLE_BOUNDS_CHECK)
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	531 crefT operator () (octave_idx_type n) const { return checkelem (n); }
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	532 crefT operator () (octave_idx_type i, octave_idx_type j) const
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	533 { return checkelem (i, j); }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	534 crefT operator () (octave_idx_type i, octave_idx_type j,
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	535 octave_idx_type k) const
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	536 { return checkelem (i, j, k); }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	537 crefT operator () (const Array<octave_idx_type>& ra_idx) const
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	538 { return checkelem (ra_idx); }
2006 95e952f72d66 [project @ 1996-03-04 00:33:32 by jwe] jwe parents: 2005 diff changeset	539 #else
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	540 crefT operator () (octave_idx_type n) const { return elem (n); }
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	541 crefT operator () (octave_idx_type i, octave_idx_type j) const
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	542 { return elem (i, j); }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	543 crefT operator () (octave_idx_type i, octave_idx_type j,
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	544 octave_idx_type k) const
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	545 { return elem (i, j, k); }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	546 crefT operator () (const Array<octave_idx_type>& ra_idx) const
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	547 { return elem (ra_idx); }
2006 95e952f72d66 [project @ 1996-03-04 00:33:32 by jwe] jwe parents: 2005 diff changeset	548 #endif
95e952f72d66 [project @ 1996-03-04 00:33:32 by jwe] jwe parents: 2005 diff changeset	549
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	550 // Fast extractors. All of these produce shallow copies.
21131 54527108599a store more --enable-FEATURE info in octave_config_info John W. Eaton <jwe@octave.org> parents: 21040 diff changeset	551 // Warning: none of these do check bounds, unless
21229 a83e7a384ee0 create and install a subset of config.h in octave-config.h John W. Eaton <jwe@octave.org> parents: 21139 diff changeset	552 // OCTAVE_ENABLE_BOUNDS_CHECK is defined!
9731 7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	553
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	554 //! Extract column: A(:,k+1).
9731 7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	555 Array<T> column (octave_idx_type k) const;
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	556 //! Extract page: A(:,:,k+1).
9731 7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	557 Array<T> page (octave_idx_type k) const;
7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	558
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	559 //! Extract a slice from this array as a column vector: A(:)(lo+1:up).
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	560 //! Must be 0 <= lo && up <= numel. May be up < lo.
9731 7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	561 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	562
10352 a3635bc1ea19 remove Array2 Jaroslav Hajek <highegg@gmail.com> parents: 10350 diff changeset	563 Array<T> reshape (octave_idx_type nr, octave_idx_type nc) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	564 { return Array<T> (*this, dim_vector (nr, nc)); }
10352 a3635bc1ea19 remove Array2 Jaroslav Hajek <highegg@gmail.com> parents: 10350 diff changeset	565
9731 7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	566 Array<T> reshape (const dim_vector& new_dims) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	567 { return Array<T> (*this, new_dims); }
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4559 diff changeset	568
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	569 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	570 Array<T> ipermute (const Array<octave_idx_type>& vec) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	571 { return permute (vec, true); }
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4587 diff changeset	572
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	573 bool is_square (void) const { return (dim1 () == dim2 ()); }
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	574
4559 802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4548 diff changeset	575 bool is_empty (void) const { return numel () == 0; }
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4548 diff changeset	576
9026 6890d411a0b8 adjust some array dim query methods Jaroslav Hajek <highegg@gmail.com> parents: 9025 diff changeset	577 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	578
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	579 Array<T> transpose (void) const;
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7717 diff changeset	580 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	581
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	582 const T *data (void) const { return slice_data; }
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	583
3952 945e8c160191 [project @ 2002-05-23 17:18:12 by jwe] jwe parents: 3944 diff changeset	584 const T *fortran_vec (void) const { return data (); }
945e8c160191 [project @ 2002-05-23 17:18:12 by jwe] jwe parents: 3944 diff changeset	585
238 780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe] jwe parents: 228 diff changeset	586 T *fortran_vec (void);
1560 27a03373de41 [project @ 1995-10-12 07:22:26 by jwe] jwe parents: 1550 diff changeset	587
9546 1beb23d2b892 optimize op= in common cases Jaroslav Hajek <highegg@gmail.com> parents: 9341 diff changeset	588 bool is_shared (void) { return rep->count > 1; }
1beb23d2b892 optimize op= in common cases Jaroslav Hajek <highegg@gmail.com> parents: 9341 diff changeset	589
21660 53728df3e4c9 maint: for clarity, call ndims() rather than length() on dimension vectors. Rik <rik@octave.org> parents: 21574 diff changeset	590 int ndims (void) const { return dimensions.ndims (); }
1560 27a03373de41 [project @ 1995-10-12 07:22:26 by jwe] jwe parents: 1550 diff changeset	591
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	592 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	593 //! Indexing without resizing.
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	594 Array<T> index (const idx_vector& i) const;
1560 27a03373de41 [project @ 1995-10-12 07:22:26 by jwe] jwe parents: 1550 diff changeset	595
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	596 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	597
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	598 Array<T> index (const Array<idx_vector>& ia) const;
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	599 //@}
1560 27a03373de41 [project @ 1995-10-12 07:22:26 by jwe] jwe parents: 1550 diff changeset	600
14616 13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	601 virtual T resize_fill_value (void) const;
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	602
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	603 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	604 //! Resizing (with fill).
19330 1f4455ff2329 Remove deprecated methods in liboctave. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19326 diff changeset	605 void resize2 (octave_idx_type nr, octave_idx_type nc, const T& rfv);
1f4455ff2329 Remove deprecated methods in liboctave. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19326 diff changeset	606 void resize2 (octave_idx_type nr, octave_idx_type nc)
14616 13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	607 {
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	608 resize2 (nr, nc, resize_fill_value ());
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	609 }
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	610
19330 1f4455ff2329 Remove deprecated methods in liboctave. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19326 diff changeset	611 void resize1 (octave_idx_type n, const T& rfv);
1f4455ff2329 Remove deprecated methods in liboctave. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19326 diff changeset	612 void resize1 (octave_idx_type n) { resize1 (n, resize_fill_value ()); }
1f4455ff2329 Remove deprecated methods in liboctave. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19326 diff changeset	613
14616 13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	614 void resize (const dim_vector& dv, const T& rfv);
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	615 void resize (const dim_vector& dv) { resize (dv, resize_fill_value ()); }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	616 //@}
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	617
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	618 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	619 //! Indexing with possible resizing and fill
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	620
19861 19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	621 // FIXME: this is really a corner case, that should better be
8333 9238637cb81c style fixes John W. Eaton <jwe@octave.org> parents: 8290 diff changeset	622 // handled directly in liboctinterp.
3933 f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3928 diff changeset	623
14616 13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	624 Array<T> index (const idx_vector& i, bool resize_ok, const T& rfv) const;
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	625 Array<T> index (const idx_vector& i, bool resize_ok) const
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	626 {
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	627 return index (i, resize_ok, resize_fill_value ());
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	628 }
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	629
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	630 Array<T> index (const idx_vector& i, const idx_vector& j, bool resize_ok,
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	631 const T& rfv) const;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	632 Array<T> index (const idx_vector& i, const idx_vector& j,
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	633 bool resize_ok) const
14616 13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	634 {
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	635 return index (i, j, resize_ok, resize_fill_value ());
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	636 }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	637
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	638 Array<T> index (const Array<idx_vector>& ia, bool resize_ok,
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	639 const T& rfv) const;
14616 13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	640 Array<T> index (const Array<idx_vector>& ia, bool resize_ok) const
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	641 {
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	642 return index (ia, resize_ok, resize_fill_value ());
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	643 }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	644 //@}
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	645
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	646 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	647 //! Indexed assignment (always with resize & fill).
14616 13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	648 void assign (const idx_vector& i, const Array<T>& rhs, const T& rfv);
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	649 void assign (const idx_vector& i, const Array<T>& rhs)
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	650 {
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	651 assign (i, rhs, resize_fill_value ());
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	652 }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	653
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	654 void assign (const idx_vector& i, const idx_vector& j, const Array<T>& rhs,
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	655 const T& rfv);
14616 13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	656 void assign (const idx_vector& i, const idx_vector& j, const Array<T>& rhs)
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	657 {
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	658 assign (i, j, rhs, resize_fill_value ());
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	659 }
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	660
14616 13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	661 void assign (const Array<idx_vector>& ia, const Array<T>& rhs, const T& rfv);
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	662 void assign (const Array<idx_vector>& ia, const Array<T>& rhs)
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	663 {
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	664 assign (ia, rhs, resize_fill_value ());
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	665 }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	666 //@}
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	667
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	668 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	669 //! Deleting elements.
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	670
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	671 //! A(I) = [] (with a single subscript)
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	672 void delete_elements (const idx_vector& i);
4530 e8d87fefd144 [project @ 2003-10-07 04:02:04 by jwe] jwe parents: 4518 diff changeset	673
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	674 //! A(:,...,I,...,:) = [] (>= 2 subscripts, one of them is non-colon)
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	675 void delete_elements (int dim, const idx_vector& i);
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	676
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	677 //! Dispatcher to the above two.
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	678 void delete_elements (const Array<idx_vector>& ia);
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	679 //@}
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	680
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	681 //! Insert an array into another at a specified position. If
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	682 //! size (a) is [d1 d2 ... dN] and idx is [i1 i2 ... iN], this
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	683 //! method is equivalent to x(i1:i1+d1-1, i2:i2+d2-1, ... ,
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	684 //! iN:iN+dN-1) = a.
10115 ed49cef7e005 simplify Array::insert methods Jaroslav Hajek <highegg@gmail.com> parents: 10095 diff changeset	685 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	686
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	687 //! 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	688 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	689
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	690 void maybe_economize (void)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	691 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	692 if (rep->count == 1 && slice_len != rep->len)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	693 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	694 ArrayRep *new_rep = new ArrayRep (slice_data, slice_len);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	695 delete rep;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	696 rep = new_rep;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	697 slice_data = rep->data;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	698 }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	699 }
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	700
4517 b4449b1193ac [project @ 2003-09-20 02:06:06 by jwe] jwe parents: 4513 diff changeset	701 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	702
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	703 //! Give a pointer to the data in mex format. Unsafe. This function
b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	704 //! exists to support the MEX interface. You should not use it
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	705 //! anywhere else.
5900 c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe] jwe parents: 5775 diff changeset	706 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	707
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9653 diff changeset	708 Array<T> sort (int dim = 0, sortmode mode = ASCENDING) const;
aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9653 diff changeset	709 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	710 sortmode mode = ASCENDING) const;
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	711
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	712 //! Ordering is auto-detected or can be specified.
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8700 diff changeset	713 sortmode is_sorted (sortmode mode = UNSORTED) const;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8700 diff changeset	714
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	715 //! Sort by rows returns only indices.
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8700 diff changeset	716 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	717
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	718 //! Ordering is auto-detected or can be specified.
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8700 diff changeset	719 sortmode is_sorted_rows (sortmode mode = UNSORTED) const;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8700 diff changeset	720
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	721 //! @brief Do a binary lookup in a sorted array. Must not contain NaNs.
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	722 //! Mode can be specified or is auto-detected by comparing 1st and last element.
8814 de16ebeef93d improve lookup, provide Array<T>::lookup Jaroslav Hajek <highegg@gmail.com> parents: 8725 diff changeset	723 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	724
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	725 //! Ditto, but for an array of values, specializing on the case when values
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	726 //! are sorted. NaNs get the value N.
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	727 Array<octave_idx_type> lookup (const Array<T>& values,
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	728 sortmode mode = UNSORTED) const;
9341 9fd5c56ce57a extend lookup capabilities Jaroslav Hajek <highegg@gmail.com> parents: 9201 diff changeset	729
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	730 //! Count nonzero elements.
9878 ead4f9c82a9a implement Array<T>::nnz Jaroslav Hajek <highegg@gmail.com> parents: 9840 diff changeset	731 octave_idx_type nnz (void) const;
ead4f9c82a9a implement Array<T>::nnz Jaroslav Hajek <highegg@gmail.com> parents: 9840 diff changeset	732
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	733 //! Find indices of (at most n) nonzero elements. If n is specified,
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	734 //! backward specifies search from backward.
19861 19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	735 Array<octave_idx_type> find (octave_idx_type n = -1,
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	736 bool backward = false) const;
9025 484756d558d6 add Array<T>::find Jaroslav Hajek <highegg@gmail.com> parents: 8998 diff changeset	737
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	738 //! Returns the n-th element in increasing order, using the same
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	739 //! ordering as used for sort. n can either be a scalar index or a
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	740 //! contiguous range.
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9653 diff changeset	741 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	742
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	743 //! Get the kth super or subdiagonal. The zeroth diagonal is the
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	744 //! ordinary diagonal.
7620 36594d5bbe13 Move diag function into the octave_value class David Bateman <dbateman@free.fr> parents: 7503 diff changeset	745 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	746
14557 e8e86ae3abbc make diag (x, m, n) return a proper diagonal matrix object (bug #36099) John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	747 Array<T> diag (octave_idx_type m, octave_idx_type n) const;
e8e86ae3abbc make diag (x, m, n) return a proper diagonal matrix object (bug #36099) John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	748
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	749 //! Concatenation along a specified (0-based) dimension, equivalent
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	750 //! to cat(). dim = -1 corresponds to dim = 0 and dim = -2
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	751 //! corresponds to dim = 1, but apply the looser matching rules of
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	752 //! vertcat/horzcat.
10531 2dd8ea8bfd71 basic cat functionality in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 10521 diff changeset	753 static Array<T>
2dd8ea8bfd71 basic cat functionality in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 10521 diff changeset	754 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	755
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	756 //! Apply function fcn to each element of the Array<T>. This function
21567 3d25f9f4a62b maint: Eliminate Britishicisms in the code. Rik <rik@octave.org> parents: 21244 diff changeset	757 //! is optimized with a manually unrolled loop.
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	758 template <typename U, typename F>
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	759 Array<U>
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	760 map (F fcn) const
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	761 {
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20229 diff changeset	762 octave_idx_type len = numel ();
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	763
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	764 const T *m = data ();
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	765
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	766 Array<U> result (dims ());
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	767 U *p = result.fortran_vec ();
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	768
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	769 octave_idx_type i;
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	770 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	771 {
10312 cbc402e64d83 untabify liboctave header files John W. Eaton <jwe@octave.org> parents: 10158 diff changeset	772 octave_quit ();
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	773
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	774 p[i] = fcn (m[i]);
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	775 p[i+1] = fcn (m[i+1]);
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	776 p[i+2] = fcn (m[i+2]);
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	777 p[i+3] = fcn (m[i+3]);
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	778 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	779
10142 829e69ec3110 make OCTAVE_QUIT a function Jaroslav Hajek <highegg@gmail.com> parents: 10115 diff changeset	780 octave_quit ();
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	781
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	782 for (; i < len; i++)
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	783 p[i] = fcn (m[i]);
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	784
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	785 return result;
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	786 }
8998 a48fba01e4ac optimize isnan/isinf/isfinite mappers Jaroslav Hajek <highegg@gmail.com> parents: 8950 diff changeset	787
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	788 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	789 //! Overloads for function references.
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	790 template <typename U>
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	791 Array<U>
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	792 map (U (&fcn) (T)) const
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	793 { return map<U, U (&) (T)> (fcn); }
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	794
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	795 template <typename U>
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	796 Array<U>
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	797 map (U (&fcn) (const T&)) const
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	798 { return map<U, U (&) (const T&)> (fcn); }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	799 //@}
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	800
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	801 //! Generic any/all test functionality with arbitrary predicate.
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	802 template <typename F, bool zero>
11010 9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	803 bool test (F fcn) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	804 {
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20229 diff changeset	805 return any_all_test<F, T, zero> (fcn, data (), numel ());
11010 9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	806 }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	807
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	808 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	809 //! Simpler calls.
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	810 template <typename F>
11010 9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	811 bool test_any (F fcn) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	812 { return test<F, false> (fcn); }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	813
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	814 template <typename F>
11010 9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	815 bool test_all (F fcn) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	816 { return test<F, true> (fcn); }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	817 //@}
11010 9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	818
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	819 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	820 //! Overloads for function references.
11010 9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	821 bool test_any (bool (&fcn) (T)) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	822 { return test<bool (&) (T), false> (fcn); }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	823
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	824 bool test_any (bool (&fcn) (const T&)) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	825 { return test<bool (&) (const T&), false> (fcn); }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	826
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	827 bool test_all (bool (&fcn) (T)) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	828 { return test<bool (&) (T), true> (fcn); }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	829
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	830 bool test_all (bool (&fcn) (const T&)) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	831 { return test<bool (&) (const T&), true> (fcn); }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	832 //@}
11010 9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	833
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	834 template <typename U> friend class Array;
9201 472f0e22aa60 guard against implicit instantiation Jaroslav Hajek <highegg@gmail.com> parents: 9046 diff changeset	835
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	836 //! Returns true if this->dims () == dv, and if so, replaces this->dimensions
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	837 //! by a shallow copy of dv. This is useful for maintaining several arrays
b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	838 //! with supposedly equal dimensions (e.g. structs in the interpreter).
10674 e3064439d6b4 new Array method for internal use Jaroslav Hajek <highegg@gmail.com> parents: 10673 diff changeset	839 bool optimize_dimensions (const dim_vector& dv);
e3064439d6b4 new Array method for internal use Jaroslav Hajek <highegg@gmail.com> parents: 10673 diff changeset	840
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	841 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	842 //! WARNING: Only call these functions from jit
19330 1f4455ff2329 Remove deprecated methods in liboctave. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19326 diff changeset	843
14951 4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	844 int *jit_ref_count (void) { return rep->count.get (); }
4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	845
4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	846 T *jit_slice_data (void) const { return slice_data; }
4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	847
4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	848 octave_idx_type *jit_dimensions (void) const { return dimensions.to_jit (); }
4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	849
4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	850 void *jit_array_rep (void) const { return rep; }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	851 //@}
14951 4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	852
9201 472f0e22aa60 guard against implicit instantiation Jaroslav Hajek <highegg@gmail.com> parents: 9046 diff changeset	853 private:
472f0e22aa60 guard against implicit instantiation Jaroslav Hajek <highegg@gmail.com> parents: 9046 diff changeset	854 static void instantiation_guard ();
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	855 };
4459 75ee1995d2b4 [project @ 2003-07-11 17:46:41 by jwe] jwe parents: 4192 diff changeset	856
22139 f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	857 // We use a variadic template for template template parameter so that
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	858 // we don't have to specify all the template parameters and limit this
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	859 // to Container<T>. http://stackoverflow.com/a/20499809/1609556
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	860 template<typename T>
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	861 template<template <typename...> class Container>
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	862 Array<T>::Array (const Container<T>& a, const dim_vector& dv)
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	863 : dimensions (dv), rep (new typename Array<T>::ArrayRep (dv.safe_numel ())),
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	864 slice_data (rep->data), slice_len (rep->len)
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	865 {
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	866 if (dimensions.safe_numel () != octave_idx_type (a.size ()))
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	867 {
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	868 std::string new_dims_str = dimensions.str ();
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	869
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	870 (*current_liboctave_error_handler)
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	871 ("reshape: can't reshape %i elements into %s array",
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	872 a.size (), new_dims_str.c_str ());
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	873 }
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	874
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	875 octave_idx_type i = 0;
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	876 for (const T& x : a)
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	877 slice_data[i++] = x;
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	878
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	879 dimensions.chop_trailing_singletons ();
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	880 }
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	881
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	882 //! This is a simple wrapper template that will subclass an Array<T>
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	883 //! type or any later type derived from it and override the default
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	884 //! non-const operator() to not check for the array's uniqueness. It
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	885 //! is, however, the user's responsibility to ensure the array is
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	886 //! actually unaliased whenever elements are accessed.
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	887 template <typename ArrayClass>
9653 e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	888 class NoAlias : public ArrayClass
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	889 {
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	890 typedef typename ArrayClass::element_type T;
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	891 public:
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	892 NoAlias () : ArrayClass () { }
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	893
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	894 // FIXME: this would be simpler once C++0x is available
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	895 template <typename X>
9653 e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	896 explicit NoAlias (X x) : ArrayClass (x) { }
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	897
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	898 template <typename X, typename Y>
9653 e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	899 explicit NoAlias (X x, Y y) : ArrayClass (x, y) { }
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	900
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	901 template <typename X, typename Y, typename Z>
9653 e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	902 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	903
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	904 T& operator () (octave_idx_type n)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	905 { return ArrayClass::xelem (n); }
9653 e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	906 T& operator () (octave_idx_type i, octave_idx_type j)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	907 { return ArrayClass::xelem (i, j); }
9653 e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	908 T& operator () (octave_idx_type i, octave_idx_type j, octave_idx_type k)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	909 { return ArrayClass::xelem (i, j, k); }
9653 e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	910 T& operator () (const Array<octave_idx_type>& ra_idx)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	911 { return ArrayClass::xelem (ra_idx); }
9653 e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	912 };
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	913
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	914 template <typename T>
9732 b4fdfee405b5 remove ArrayN<T> + fix nonhom. diag-scalar ops Jaroslav Hajek <highegg@gmail.com> parents: 9731 diff changeset	915 std::ostream&
b4fdfee405b5 remove ArrayN<T> + fix nonhom. diag-scalar ops Jaroslav Hajek <highegg@gmail.com> parents: 9731 diff changeset	916 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	917
9773 01f897d8a130 optimize memory manipulation by arrays & indexing Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	918 #endif

Mercurial > octave

annotate liboctave/array/Array.h @ 23220:092078913d54