octave: liboctave/array/Array.h annotate

annotate liboctave/array/Array.h @ 26569:0e77df67b522 stable

Add static compile-time checking of printf functions in liboctave. * util/lo-error.h: Use macro OCTAVE_FORMAT_PRINTF for printf functions. * array/Array.h: Use format specifier "z" for type size_t. * array/Array-util.cc, numeric/oct-norm.cc: Supply a format string of "%s" when printing a single string. * array/idx-vector.cc, array/MatrixType.cc, array/Sparse.cc, numeric/DASPK.cc, numeric/DASRT.cc, numeric/DASSL.cc, numeric/LSODE.cc, util/lo-array-errwarn.cc, util/sparse-util.cc: Use preprocessor macro OCTAVE_IDX_TYPE_FORMAT as the format identifier for octave_idx_type. * util/f77-fcn.c: Cast width argument to int. * util/lo-utils.cc: Pass missing argument c0.

author	Markus Mützel <markus.muetzel@gmx.de>
date	Thu, 17 Jan 2019 19:25:55 +0100
parents	00f796120a6d
children	7f5bbd5ac5a5 2310164737b3

rev	line source
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	1 /*
ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	2
26376 00f796120a6d maint: Update copyright dates in all source files. John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	3 Copyright (C) 1993-2019 John W. Eaton
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 11507 diff changeset	4 Copyright (C) 2008-2009 Jaroslav Hajek
10521 4d1fc073fbb7 add some missing copyright stmts Jaroslav Hajek <highegg@gmail.com> parents: 10366 diff changeset	5 Copyright (C) 2010 VZLU Prague
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	6
ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	7 This file is part of Octave.
ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	8
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23795 diff changeset	9 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	10 under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23795 diff changeset	11 the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	12 (at your option) any later version.
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	13
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	14 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	15 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	17 GNU General Public License for more details.
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	18
ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	19 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	20 along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23795 diff changeset	21 <https://www.gnu.org/licenses/>.
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	22
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
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 20232 diff changeset	25 #if ! defined (octave_Array_h)
382 e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe] jwe parents: 376 diff changeset	26 #define octave_Array_h 1
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe] jwe parents: 376 diff changeset	27
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21229 diff changeset	28 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21229 diff changeset	29
1366 f75432dff006 [project @ 1995-09-05 23:56:42 by jwe] jwe parents: 1359 diff changeset	30 #include <cassert>
4152 f14251d33b01 [project @ 2002-11-06 18:41:50 by jwe] jwe parents: 4066 diff changeset	31 #include <cstddef>
3613 0a93682f89c8 [project @ 2000-03-17 10:58:25 by jwe] jwe parents: 3585 diff changeset	32
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	33 #include <algorithm>
8950 d865363208d6 include <iosfwd> instead of <iostream> in header files John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	34 #include <iosfwd>
23443 3f1bf237908b maint: Eliminate <cfloat.h> header from liboctave files. Rik <rik@octave.org> parents: 23420 diff changeset	35 #include <string>
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"
23443 3f1bf237908b maint: Eliminate <cfloat.h> header from liboctave files. Rik <rik@octave.org> parents: 23420 diff changeset	42 #include "oct-refcount.h"
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7017 diff changeset	43 #include "oct-sort.h"
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	44 #include "quit.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.
24624 ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	47 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	48 //! The Array class is at the root of Octave. It provides a container
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	49 //! with an arbitrary number of dimensions. The operator () provides
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	50 //! access to individual elements via subscript and linear indexing.
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	51 //! Indexing starts at 0. Arrays are column-major order as in Fortran.
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	52 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	53 //! @code{.cc}
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	54 //! // 3 D Array with 10 rows, 20 columns, and 5 pages, filled with 7.0
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	55 //! Array<double> A Array<double (dim_vector (10, 20, 5), 7.0);
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	56 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	57 //! // set value for row 0, column 10, and page 3
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	58 //! A(0, 10, 3) = 2.5;
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	59 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	60 //! // get value for row 1, column 2, and page 0
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	61 //! double v = A(1, 2, 0);
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	62 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	63 //! // get value for 25th element (row 4, column 3, page 1)
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	64 //! double v = A(24);
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	65 //! @endcode
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	66 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	67 //! ## Notes on STL compatibility
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	68 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	69 //! ### size() and length()
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	70 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	71 //! To access the total number of elements in an Array, use numel()
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	72 //! which is short for number of elements and is equivalent to the
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	73 //! Octave function with same name.
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	74 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	75 //! @code{.cc}
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	76 //! Array<int> A (dim_vector (10, 20, 4), 1);
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	77 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	78 //! octave_idx_type n = A.numel (); // returns 800 (10x20x4)
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	79 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	80 //! octave_idx_type nr = A.size (0); // returns 10 (number of rows/dimension 0)
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	81 //! octave_idx_type nc = A.size (1); // returns 20 (number of columns)
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	82 //! octave_idx_type nc = A.size (2); // returns 4 (size of dimension 3)
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	83 //! octave_idx_type l6 = A.size (6); // returns 1 (implicit singleton dimension)
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	84 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	85 //! // Alternatively, get a dim_vector which represents the dimensions.
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	86 //! dim_vector dims = A.dims ();
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	87 //! @endcode
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	88 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	89 //! The methods size() and length() as they exist in the STL cause
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	90 //! confusion in the context of a N dimensional array.
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	91 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	92 //! The size() of an array is the length of all dimensions. In Octave,
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	93 //! the size() function returns a row vector with the length of each
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	94 //! dimension, or the size of a specific dimension. Only the latter is
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	95 //! present in liboctave.
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	96 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	97 //! Since there is more than 1 dimension, length() would not make sense
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	98 //! without expliciting which dimension. If the function existed, which
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	99 //! length should it return? Octave length() function returns the length
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	100 //! of the longest dimension which is an odd definition, only useful for
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	101 //! vectors and square matrices. The alternatives numel(), rows(),
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	102 //! columns(), and size(d) are more explict and recommended.
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	103 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	104 //! ### size_type
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	105 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	106 //! Array::size_type is `octave_idx_type` which is a typedef for `int`
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	107 //! or `long int`, depending whether Octave was configured for 64-bit
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	108 //! indexing.
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	109 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	110 //! This is a signed integer which may cause problems when mixed with
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	111 //! STL containers. The reason is that Octave interacts with Fortran
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	112 //! routines, providing an interface many Fortran numeric libraries.
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	113 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	114 //! ## Subclasses
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	115 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	116 //! The following subclasses specializations, will be of most use:
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	117 //! - Matrix: Array<double> with only 2 dimensions
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	118 //! - ComplexMatrix: Array<std::complex<double>> with only 2 dimensions
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	119 //! - boolNDArray: N dimensional Array<bool>
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	120 //! - ColumnVector: Array<double> with 1 column
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	121 //! - string_vector: Array<std::string> with 1 column
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	122 //! - Cell: Array<octave_value>, equivalent to an Octave cell.
22279 3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	123
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	124 template <typename T>
3585 d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3569 diff changeset	125 class
d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3569 diff changeset	126 Array
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	127 {
3504 5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe] jwe parents: 2847 diff changeset	128 protected:
1619 1a35c8c91349 [project @ 1995-11-04 11:07:21 by jwe] jwe parents: 1574 diff changeset	129
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	130 //! The real representation of all arrays.
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	131 class ArrayRep
d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	132 {
d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	133 public:
d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	134
d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	135 T *data;
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	136 octave_idx_type len;
23012 27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	137 octave::refcount<int> count;
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	138
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	139 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	140 : 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	141 {
23420 1fee389bd04b Use std::copy_n rather than std::copy for clarity in liboctave/array. Rik <rik@octave.org> parents: 23401 diff changeset	142 std::copy_n (d, l, data);
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	143 }
10364 96ed7c629bbd remove dangerous pointer-acquiring Array ctors Jaroslav Hajek <highegg@gmail.com> parents: 10358 diff changeset	144
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	145 template <typename U>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	146 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	147 : 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	148 {
23420 1fee389bd04b Use std::copy_n rather than std::copy for clarity in liboctave/array. Rik <rik@octave.org> parents: 23401 diff changeset	149 std::copy_n (d, l, data);
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	150 }
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	151
23401 e0c20a22da7e eliminate some errors exposed by -fsanitize=undefined John W. Eaton <jwe@octave.org> parents: 23386 diff changeset	152 // Use new instead of setting data to 0 so that fortran_vec and
e0c20a22da7e eliminate some errors exposed by -fsanitize=undefined John W. Eaton <jwe@octave.org> parents: 23386 diff changeset	153 // data always return valid addresses, even for zero-size arrays.
e0c20a22da7e eliminate some errors exposed by -fsanitize=undefined John W. Eaton <jwe@octave.org> parents: 23386 diff changeset	154
e0c20a22da7e eliminate some errors exposed by -fsanitize=undefined John W. Eaton <jwe@octave.org> parents: 23386 diff changeset	155 ArrayRep (void) : data (new T [0]), len (0), count (1) { }
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	156
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	157 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	158 : data (new T [n]), len (n), count (1) { }
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	159
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	160 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	161 : 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	162 {
19381 af41e41ad28e replace oct-mem.h inline indirections by standard function calls. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19330 diff changeset	163 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	164 }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	165
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	166 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	167 : 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	168 {
23420 1fee389bd04b Use std::copy_n rather than std::copy for clarity in liboctave/array. Rik <rik@octave.org> parents: 23401 diff changeset	169 std::copy_n (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	170 }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	171
19381 af41e41ad28e replace oct-mem.h inline indirections by standard function calls. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19330 diff changeset	172 ~ArrayRep (void) { delete [] data; }
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	173
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20229 diff changeset	174 octave_idx_type numel (void) const { return len; }
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	175
4517 b4449b1193ac [project @ 2003-09-20 02:06:06 by jwe] jwe parents: 4513 diff changeset	176 private:
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 // No assignment!
b4449b1193ac [project @ 2003-09-20 02:06:06 by jwe] jwe parents: 4513 diff changeset	179
b4449b1193ac [project @ 2003-09-20 02:06:06 by jwe] jwe parents: 4513 diff changeset	180 ArrayRep& operator = (const ArrayRep& a);
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	181 };
d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	182
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	183 //--------------------------------------------------------------------
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	184
6884 1cbb8b606d63 [project @ 2007-09-10 20:43:26 by jwe] jwe parents: 6881 diff changeset	185 public:
1cbb8b606d63 [project @ 2007-09-10 20:43:26 by jwe] jwe parents: 6881 diff changeset	186
9556 948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	187 void make_unique (void)
17769 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 if (rep->count > 1)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	190 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	191 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	192
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	193 if (--rep->count == 0)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	194 delete rep;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	195
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	196 rep = r;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	197 slice_data = rep->data;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	198 }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	199 }
238 780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe] jwe parents: 228 diff changeset	200
5900 c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe] jwe parents: 5775 diff changeset	201 typedef T element_type;
c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe] jwe parents: 5775 diff changeset	202
22279 3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	203 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	204
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	205 //! 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	206 //! (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	207 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	208
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	209 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	210
8725 d5af326a3ede [mq]: sort-traits John W. Eaton <jwe@octave.org> parents: 8721 diff changeset	211 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	212 typename ref_param<T>::type);
8725 d5af326a3ede [mq]: sort-traits John W. Eaton <jwe@octave.org> parents: 8721 diff changeset	213
8524 937921654627 clean up Array and DiagArray2 Jaroslav Hajek <highegg@gmail.com> parents: 8523 diff changeset	214 protected:
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: 4834 diff changeset	215
11507 c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	216 dim_vector dimensions;
4518 382cb0ed8c14 [project @ 2003-09-20 18:08:40 by jwe] jwe parents: 4517 diff changeset	217
11507 c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	218 typename Array<T>::ArrayRep *rep;
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	219
8531 b01fef323c24 add some explaining comments Jaroslav Hajek <highegg@gmail.com> parents: 8524 diff changeset	220 // Rationale:
b01fef323c24 add some explaining comments Jaroslav Hajek <highegg@gmail.com> parents: 8524 diff changeset	221 // 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	222 // 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	223 // 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	224 // 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	225 // and slice_len need to be properly updated.
8531 b01fef323c24 add some explaining comments Jaroslav Hajek <highegg@gmail.com> parents: 8524 diff changeset	226
23449 c763214a8260 maint: Use convention 'int x' for naming pointers. Rik <rik@octave.org>* parents: 23446 diff changeset	227 T *slice_data;
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	228 octave_idx_type slice_len;
ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	229
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	230 //! slice constructor
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	231 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	232 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	233 : 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	234 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	235 rep->count++;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	236 dimensions.chop_trailing_singletons ();
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	237 }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	238
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	239 private:
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	240
21573 f3f8e1d3e399 avoid mulitple definitions of static function-scope vars (bug #47372) John W. Eaton <jwe@octave.org> parents: 20212 diff changeset	241 static typename Array<T>::ArrayRep *nil_rep (void);
238 780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe] jwe parents: 228 diff changeset	242
14951 4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	243 protected:
4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	244
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	245 //! For jit support
14951 4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	246 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	247 : dimensions (adims),
4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	248 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	249 slice_data (sdata), slice_len (slen) { }
14951 4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	250
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	251 public:
238 780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe] jwe parents: 228 diff changeset	252
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	253 //! Empty ctor (0 by 0).
1550 d89532de8e72 [project @ 1995-10-08 01:12:20 by jwe] jwe parents: 1366 diff changeset	254 Array (void)
11507 c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	255 : 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	256 slice_len (rep->len)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	257 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	258 rep->count++;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	259 }
1550 d89532de8e72 [project @ 1995-10-08 01:12:20 by jwe] jwe parents: 1366 diff changeset	260
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	261 //! nD uninitialized ctor.
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	262 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	263 : dimensions (dv),
c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	264 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	265 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	266 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	267 dimensions.chop_trailing_singletons ();
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	268 }
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	269
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	270 //! nD initialized ctor.
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	271 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	272 : dimensions (dv),
c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	273 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	274 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	275 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	276 fill (val);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	277 dimensions.chop_trailing_singletons ();
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	278 }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	279
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	280 //! Reshape constructor.
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	281 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	282
22139 f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	283 //! 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	284 template<template <typename...> class Container>
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	285 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	286
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	287 //! Type conversion case.
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	288 template <typename U>
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: 4834 diff changeset	289 Array (const Array<U>& a)
11507 c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	290 : dimensions (a.dims ()),
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20229 diff changeset	291 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	292 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	293 { }
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: 4834 diff changeset	294
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	295 //! No type conversion case.
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	296 Array (const Array<T>& a)
11507 c3ad80f4ce36 Array.h, Array.cc: more constructor fixes John W. Eaton <jwe@octave.org> parents: 11010 diff changeset	297 : 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	298 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	299 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	300 rep->count++;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	301 }
1550 d89532de8e72 [project @ 1995-10-08 01:12:20 by jwe] jwe parents: 1366 diff changeset	302
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	303 public:
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	304
15216 dd7c37ceb800 avoid GCC warning by declaring Array destructor virtual John W. Eaton <jwe@octave.org> parents: 15212 diff changeset	305 virtual ~Array (void)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	306 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	307 if (--rep->count == 0)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	308 delete rep;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	309 }
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	310
9556 948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	311 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	312 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	313 if (this != &a)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	314 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	315 if (--rep->count == 0)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	316 delete rep;
9556 948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	317
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	318 rep = a.rep;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	319 rep->count++;
9556 948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	320
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	321 dimensions = a.dimensions;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	322 slice_data = a.slice_data;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	323 slice_len = a.slice_len;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	324 }
9556 948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	325
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	326 return *this;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	327 }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	328
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	329 void fill (const T& val);
9624 3fc7272937ce implement Array<T>::clear overloads Jaroslav Hajek <highegg@gmail.com> parents: 9556 diff changeset	330
9546 1beb23d2b892 optimize op= in common cases Jaroslav Hajek <highegg@gmail.com> parents: 9341 diff changeset	331 void clear (void);
9624 3fc7272937ce implement Array<T>::clear overloads Jaroslav Hajek <highegg@gmail.com> parents: 9556 diff changeset	332 void clear (const dim_vector& dv);
3fc7272937ce implement Array<T>::clear overloads Jaroslav Hajek <highegg@gmail.com> parents: 9556 diff changeset	333
3fc7272937ce implement Array<T>::clear overloads Jaroslav Hajek <highegg@gmail.com> parents: 9556 diff changeset	334 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	335 { clear (dim_vector (r, c)); }
238 780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe] jwe parents: 228 diff changeset	336
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	337 // 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	338 //@{
20212 6af35d4f1ba4 doxygen: document Array::length() and similar methods (bug #45138) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	339 //! 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	340 //! Synonymous with numel().
20229 5dfaaaae784f Deprecate Array::capacity() and Sparse::capacity() for numel() and nzmax(). Carnë Draug <carandraug@octave.org> parents: 20228 diff changeset	341 //! @note This method is deprecated in favour of numel().
23615 be7b884ac589 use version number in OCTAVE_DEPRECATED macro John W. Eaton <jwe@octave.org> parents: 23593 diff changeset	342 OCTAVE_DEPRECATED (4.4, "use 'numel' instead")
21134 2e5c1f766ac9 provide replacement hints for deprecated C++ functions John W. Eaton <jwe@octave.org> parents: 21131 diff changeset	343 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	344
6af35d4f1ba4 doxygen: document Array::length() and similar methods (bug #45138) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	345 //! Number of elements in the array.
24624 ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	346 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	347 //! Synonymous with numel().
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	348 //! @note This method is deprecated in favour of numel().
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	349 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	350 //! @note
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	351 //! This is @em not the same as @c %length() at the Octave interpreter.
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	352 //! At the Octave interpreter, the function @c %length() returns the
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	353 //! length of the greatest dimension. This method returns the total
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	354 //! number of elements.
20212 6af35d4f1ba4 doxygen: document Array::length() and similar methods (bug #45138) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	355
23615 be7b884ac589 use version number in OCTAVE_DEPRECATED macro John W. Eaton <jwe@octave.org> parents: 23593 diff changeset	356 OCTAVE_DEPRECATED (4.4, "use 'numel' instead")
21134 2e5c1f766ac9 provide replacement hints for deprecated C++ functions John W. Eaton <jwe@octave.org> parents: 21131 diff changeset	357 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	358
6af35d4f1ba4 doxygen: document Array::length() and similar methods (bug #45138) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	359 //! 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	360 //! Synonymous with numel().
20228 00cf2847355d Deprecate Array::nelem() and Range::nelem() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20212 diff changeset	361 //! @note This method is deprecated in favour of numel().
23615 be7b884ac589 use version number in OCTAVE_DEPRECATED macro John W. Eaton <jwe@octave.org> parents: 23593 diff changeset	362 OCTAVE_DEPRECATED (4.4, "use 'numel' instead")
21134 2e5c1f766ac9 provide replacement hints for deprecated C++ functions John W. Eaton <jwe@octave.org> parents: 21131 diff changeset	363 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	364
6af35d4f1ba4 doxygen: document Array::length() and similar methods (bug #45138) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	365 //! 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	366 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	367 //@}
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	368
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	369 //! Return the array as a column vector.
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	370 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	371 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	372 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	373 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	374 retval.dimensions = dim_vector (numel (), 1);
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	375
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	376 return retval;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	377 }
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	378
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	379 //! Return the array as a row vector.
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	380 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	381 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	382 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	383 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	384 retval.dimensions = dim_vector (1, numel ());
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	385
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	386 return retval;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	387 }
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	388
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	389 //! Return the array as a matrix.
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	390 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	391 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	392 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	393 if (dimensions.ndims () != 2)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	394 retval.dimensions = dimensions.redim (2);
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	395
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	396 return retval;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	397 }
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	398
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	399 //! @name First dimension
19330 1f4455ff2329 Remove deprecated methods in liboctave. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19326 diff changeset	400 //!
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	401 //! 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	402 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	403 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	404 octave_idx_type rows (void) const { return dim1 (); }
19006 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
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	407 //! @name Second dimension
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	408 //!
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	409 //! 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	410 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	411 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	412 octave_idx_type cols (void) const { return dim2 (); }
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	413 octave_idx_type columns (void) const { return dim2 (); }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	414 //@}
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	415
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	416 //! @name Third dimension
19330 1f4455ff2329 Remove deprecated methods in liboctave. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19326 diff changeset	417 //!
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	418 //! 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	419 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	420 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	421 octave_idx_type pages (void) const { return dim3 (); }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	422 //@}
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	423
22279 3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	424 //! Size of the specified dimension.
24624 ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	425 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	426 //! Dimensions beyond the Array number of dimensions return 1 as
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	427 //! those are implicit singleton dimensions.
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	428 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	429 //! Equivalent to Octave's `size (A, DIM)`
22279 3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	430
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	431 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	432 {
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	433 // 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	434 // 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	435 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	436 }
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	437
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	438 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	439 { return static_cast<size_t> (numel ()) * sizeof (T); }
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: 4834 diff changeset	440
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	441 //! 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	442 const dim_vector& dims (void) const { return dimensions; }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	443
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	444 //! Chop off leading singleton dimensions
4532 01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4530 diff changeset	445 Array<T> squeeze (void) const;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	446
10366 e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	447 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	448 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	449 octave_idx_type k) const;
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	450 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	451
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	452 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	453 const
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20229 diff changeset	454 { 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	455
2108 2b67abb63030 [project @ 1996-04-30 10:44:17 by jwe] jwe parents: 2049 diff changeset	456 // No checking, even for multiple references, ever.
2b67abb63030 [project @ 1996-04-30 10:44:17 by jwe] jwe parents: 2049 diff changeset	457
15018 3d8ace26c5b4 maint: Use Octave coding conventions for cuddled parentheses in liboctave/. Rik <rik@octave.org> parents: 14981 diff changeset	458 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	459 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	460
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	461 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	462 { return xelem (dim1 ()*j+i); }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	463 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	464 { return xelem (dim1 ()*j+i); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	465
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	466 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	467 { return xelem (i, dim2 ()*k+j); }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	468 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	469 { return xelem (i, dim2 ()*k+j); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	470
6867 83619ae96c1d [project @ 2007-09-06 12:08:44 by dbateman] dbateman parents: 6708 diff changeset	471 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	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
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	474 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	475 { return xelem (compute_index_unchecked (ra_idx)); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	476
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	477 // 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	478 // 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	479
10366 e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	480 T& checkelem (octave_idx_type n);
23487 af2f1f3dbe06 eliminate --enable-bounds-check configure option John W. Eaton <jwe@octave.org> parents: 23461 diff changeset	481
10366 e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	482 T& checkelem (octave_idx_type i, octave_idx_type j);
23487 af2f1f3dbe06 eliminate --enable-bounds-check configure option John W. Eaton <jwe@octave.org> parents: 23461 diff changeset	483
10366 e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	484 T& checkelem (octave_idx_type i, octave_idx_type j, octave_idx_type k);
23487 af2f1f3dbe06 eliminate --enable-bounds-check configure option John W. Eaton <jwe@octave.org> parents: 23461 diff changeset	485
10366 e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	486 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	487
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	488 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	489 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	490 make_unique ();
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	491 return xelem (n);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	492 }
2306 2fbf9bb1cd7a [project @ 1996-07-09 16:49:03 by jwe] jwe parents: 2109 diff changeset	493
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	494 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	495
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	496 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	497 { return elem (i, dim2 ()*k+j); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	498
6867 83619ae96c1d [project @ 2007-09-06 12:08:44 by dbateman] dbateman parents: 6708 diff changeset	499 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	500 { 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	501
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	502 T& operator () (octave_idx_type n) { return elem (n); }
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	503 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	504 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	505 { return elem (i, j, k); }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	506 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	507 { return elem (ra_idx); }
2006 95e952f72d66 [project @ 1996-03-04 00:33:32 by jwe] jwe parents: 2005 diff changeset	508
10366 e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	509 crefT checkelem (octave_idx_type n) const;
23487 af2f1f3dbe06 eliminate --enable-bounds-check configure option John W. Eaton <jwe@octave.org> parents: 23461 diff changeset	510
10366 e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	511 crefT checkelem (octave_idx_type i, octave_idx_type j) const;
23487 af2f1f3dbe06 eliminate --enable-bounds-check configure option John W. Eaton <jwe@octave.org> parents: 23461 diff changeset	512
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	513 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	514 octave_idx_type k) const;
23487 af2f1f3dbe06 eliminate --enable-bounds-check configure option John W. Eaton <jwe@octave.org> parents: 23461 diff changeset	515
10366 e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	516 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	517
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	518 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	519
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	520 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	521 { return xelem (i, j); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	522
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	523 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	524 { return xelem (i, j, k); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	525
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	526 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	527 { 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	528
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	529 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	530 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	531 { return elem (i, j); }
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,
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	533 octave_idx_type k) const
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	534 { return elem (i, j, k); }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	535 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	536 { return elem (ra_idx); }
2006 95e952f72d66 [project @ 1996-03-04 00:33:32 by jwe] jwe parents: 2005 diff changeset	537
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	538 // Fast extractors. All of these produce shallow copies.
9731 7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	539
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	540 //! Extract column: A(:,k+1).
9731 7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	541 Array<T> column (octave_idx_type k) const;
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	542 //! Extract page: A(:,:,k+1).
9731 7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	543 Array<T> page (octave_idx_type k) const;
7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	544
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	545 //! 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	546 //! Must be 0 <= lo && up <= numel. May be up < lo.
9731 7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	547 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	548
10352 a3635bc1ea19 remove Array2 Jaroslav Hajek <highegg@gmail.com> parents: 10350 diff changeset	549 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	550 { return Array<T> (*this, dim_vector (nr, nc)); }
10352 a3635bc1ea19 remove Array2 Jaroslav Hajek <highegg@gmail.com> parents: 10350 diff changeset	551
9731 7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	552 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	553 { return Array<T> (*this, new_dims); }
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4559 diff changeset	554
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	555 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	556 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	557 { return permute (vec, true); }
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4587 diff changeset	558
23593 a8361bc2361a maint: Deprecate is_square and replace with issquare. Rik <rik@octave.org> parents: 23592 diff changeset	559 bool issquare (void) const { return (dim1 () == dim2 ()); }
a8361bc2361a maint: Deprecate is_square and replace with issquare. Rik <rik@octave.org> parents: 23592 diff changeset	560
23615 be7b884ac589 use version number in OCTAVE_DEPRECATED macro John W. Eaton <jwe@octave.org> parents: 23593 diff changeset	561 OCTAVE_DEPRECATED (4.4, "use 'issquare' instead")
23593 a8361bc2361a maint: Deprecate is_square and replace with issquare. Rik <rik@octave.org> parents: 23592 diff changeset	562 bool is_square (void) const
a8361bc2361a maint: Deprecate is_square and replace with issquare. Rik <rik@octave.org> parents: 23592 diff changeset	563 { return issquare (); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	564
23577 80c42f4cca13 maint: Deprecate is_empty and replace with isempty. Rik <rik@octave.org> parents: 23487 diff changeset	565 bool isempty (void) const { return numel () == 0; }
80c42f4cca13 maint: Deprecate is_empty and replace with isempty. Rik <rik@octave.org> parents: 23487 diff changeset	566
23615 be7b884ac589 use version number in OCTAVE_DEPRECATED macro John W. Eaton <jwe@octave.org> parents: 23593 diff changeset	567 OCTAVE_DEPRECATED (4.4, "use 'isempty' instead")
23577 80c42f4cca13 maint: Deprecate is_empty and replace with isempty. Rik <rik@octave.org> parents: 23487 diff changeset	568 bool is_empty (void) const
80c42f4cca13 maint: Deprecate is_empty and replace with isempty. Rik <rik@octave.org> parents: 23487 diff changeset	569 { return isempty (); }
4559 802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4548 diff changeset	570
23592 80e3bfb7bd5a maint: Deprecate is_vector and replace with isvector. Rik <rik@octave.org> parents: 23588 diff changeset	571 bool isvector (void) const { return dimensions.isvector (); }
80e3bfb7bd5a maint: Deprecate is_vector and replace with isvector. Rik <rik@octave.org> parents: 23588 diff changeset	572
23615 be7b884ac589 use version number in OCTAVE_DEPRECATED macro John W. Eaton <jwe@octave.org> parents: 23593 diff changeset	573 OCTAVE_DEPRECATED (4.4, "use 'isvector' instead")
23592 80e3bfb7bd5a maint: Deprecate is_vector and replace with isvector. Rik <rik@octave.org> parents: 23588 diff changeset	574 bool is_vector (void) const
80e3bfb7bd5a maint: Deprecate is_vector and replace with isvector. Rik <rik@octave.org> parents: 23588 diff changeset	575 { return isvector (); }
9026 6890d411a0b8 adjust some array dim query methods Jaroslav Hajek <highegg@gmail.com> parents: 9025 diff changeset	576
23386 f1ea44e92df8 improve compatibility for single index indexing (bug #50776) John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	577 bool is_nd_vector (void) const { return dimensions.is_nd_vector (); }
f1ea44e92df8 improve compatibility for single index indexing (bug #50776) John W. Eaton <jwe@octave.org> parents: 23220 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;
23795 980f39c3ab90 Use C++11 nullptr rather than 0 in code (bug #51565). Rik <rik@octave.org> parents: 23615 diff changeset	580 Array<T> hermitian (T (*fcn) (const T&) = nullptr) const;
238 780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe] jwe parents: 228 diff changeset	581
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23443 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
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23443 diff changeset	584 const T * fortran_vec (void) const { return data (); }
3952 945e8c160191 [project @ 2002-05-23 17:18:12 by jwe] jwe parents: 3944 diff changeset	585
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23443 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.
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23443 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.
23588 0549061d35b9 maint: Deprecate is_sorted and replace with issorted. Rik <rik@octave.org> parents: 23577 diff changeset	713 sortmode issorted (sortmode mode = UNSORTED) const;
0549061d35b9 maint: Deprecate is_sorted and replace with issorted. Rik <rik@octave.org> parents: 23577 diff changeset	714
23615 be7b884ac589 use version number in OCTAVE_DEPRECATED macro John W. Eaton <jwe@octave.org> parents: 23593 diff changeset	715 OCTAVE_DEPRECATED (4.4, "use 'issorted' instead")
23588 0549061d35b9 maint: Deprecate is_sorted and replace with issorted. Rik <rik@octave.org> parents: 23577 diff changeset	716 sortmode is_sorted (sortmode mode = UNSORTED) const
0549061d35b9 maint: Deprecate is_sorted and replace with issorted. Rik <rik@octave.org> parents: 23577 diff changeset	717 { return issorted (mode); }
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8700 diff changeset	718
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	719 //! Sort by rows returns only indices.
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8700 diff changeset	720 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	721
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	722 //! Ordering is auto-detected or can be specified.
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8700 diff changeset	723 sortmode is_sorted_rows (sortmode mode = UNSORTED) const;
e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8700 diff changeset	724
24624 ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	725 //! 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	726 //! 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	727 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	728
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	729 //! 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	730 //! 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	731 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	732 sortmode mode = UNSORTED) const;
9341 9fd5c56ce57a extend lookup capabilities Jaroslav Hajek <highegg@gmail.com> parents: 9201 diff changeset	733
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	734 //! Count nonzero elements.
9878 ead4f9c82a9a implement Array<T>::nnz Jaroslav Hajek <highegg@gmail.com> parents: 9840 diff changeset	735 octave_idx_type nnz (void) const;
ead4f9c82a9a implement Array<T>::nnz Jaroslav Hajek <highegg@gmail.com> parents: 9840 diff changeset	736
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	737 //! 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	738 //! backward specifies search from backward.
19861 19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	739 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	740 bool backward = false) const;
9025 484756d558d6 add Array<T>::find Jaroslav Hajek <highegg@gmail.com> parents: 8998 diff changeset	741
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	742 //! 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	743 //! 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	744 //! contiguous range.
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9653 diff changeset	745 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	746
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	747 //! 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	748 //! ordinary diagonal.
7620 36594d5bbe13 Move diag function into the octave_value class David Bateman <dbateman@free.fr> parents: 7503 diff changeset	749 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	750
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	751 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	752
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	753 //! 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	754 //! 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	755 //! 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	756 //! vertcat/horzcat.
10531 2dd8ea8bfd71 basic cat functionality in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 10521 diff changeset	757 static Array<T>
2dd8ea8bfd71 basic cat functionality in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 10521 diff changeset	758 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	759
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	760 //! 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	761 //! 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	762 template <typename U, typename F>
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	763 Array<U>
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	764 map (F fcn) const
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	765 {
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20229 diff changeset	766 octave_idx_type len = numel ();
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	767
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	768 const T *m = data ();
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	769
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	770 Array<U> result (dims ());
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	771 U *p = result.fortran_vec ();
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	772
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	773 octave_idx_type i;
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	774 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	775 {
10312 cbc402e64d83 untabify liboctave header files John W. Eaton <jwe@octave.org> parents: 10158 diff changeset	776 octave_quit ();
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	777
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	778 p[i] = fcn (m[i]);
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	779 p[i+1] = fcn (m[i+1]);
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	780 p[i+2] = fcn (m[i+2]);
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	781 p[i+3] = fcn (m[i+3]);
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	782 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	783
10142 829e69ec3110 make OCTAVE_QUIT a function Jaroslav Hajek <highegg@gmail.com> parents: 10115 diff changeset	784 octave_quit ();
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	785
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	786 for (; i < len; i++)
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	787 p[i] = fcn (m[i]);
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	788
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	789 return result;
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	790 }
8998 a48fba01e4ac optimize isnan/isinf/isfinite mappers Jaroslav Hajek <highegg@gmail.com> parents: 8950 diff changeset	791
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	792 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	793 //! 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	794 template <typename U>
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	795 Array<U>
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	796 map (U (&fcn) (T)) const
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	797 { return map<U, U (&) (T)> (fcn); }
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	798
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	799 template <typename U>
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	800 Array<U>
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	801 map (U (&fcn) (const T&)) const
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	802 { return map<U, U (&) (const T&)> (fcn); }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	803 //@}
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	804
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	805 //! 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	806 template <typename F, bool zero>
11010 9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	807 bool test (F fcn) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	808 {
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20229 diff changeset	809 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	810 }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	811
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	812 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	813 //! Simpler calls.
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_any (F fcn) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	816 { return test<F, false> (fcn); }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	817
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	818 template <typename F>
11010 9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	819 bool test_all (F fcn) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	820 { return test<F, true> (fcn); }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	821 //@}
11010 9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	822
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	823 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	824 //! Overloads for function references.
11010 9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	825 bool test_any (bool (&fcn) (T)) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	826 { return test<bool (&) (T), false> (fcn); }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	827
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	828 bool test_any (bool (&fcn) (const T&)) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	829 { return test<bool (&) (const T&), false> (fcn); }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	830
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	831 bool test_all (bool (&fcn) (T)) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	832 { return test<bool (&) (T), true> (fcn); }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	833
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	834 bool test_all (bool (&fcn) (const T&)) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	835 { return test<bool (&) (const T&), true> (fcn); }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	836 //@}
11010 9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	837
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	838 template <typename U> friend class Array;
9201 472f0e22aa60 guard against implicit instantiation Jaroslav Hajek <highegg@gmail.com> parents: 9046 diff changeset	839
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	840 //! 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	841 //! 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	842 //! 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	843 bool optimize_dimensions (const dim_vector& dv);
e3064439d6b4 new Array method for internal use Jaroslav Hajek <highegg@gmail.com> parents: 10673 diff changeset	844
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	845 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	846 //! 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	847
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23443 diff changeset	848 int * jit_ref_count (void) { return rep->count.get (); }
14951 4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	849
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23443 diff changeset	850 T * jit_slice_data (void) const { return slice_data; }
14951 4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	851
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23443 diff changeset	852 octave_idx_type * jit_dimensions (void) const { return dimensions.to_jit (); }
14951 4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	853
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23443 diff changeset	854 void * jit_array_rep (void) const { return rep; }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	855 //@}
14951 4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14616 diff changeset	856
9201 472f0e22aa60 guard against implicit instantiation Jaroslav Hajek <highegg@gmail.com> parents: 9046 diff changeset	857 private:
472f0e22aa60 guard against implicit instantiation Jaroslav Hajek <highegg@gmail.com> parents: 9046 diff changeset	858 static void instantiation_guard ();
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	859 };
4459 75ee1995d2b4 [project @ 2003-07-11 17:46:41 by jwe] jwe parents: 4192 diff changeset	860
22139 f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	861 // 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	862 // 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	863 // 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	864 template<typename T>
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	865 template<template <typename...> class Container>
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	866 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	867 : 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	868 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	869 {
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	870 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	871 {
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	872 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	873
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	874 (*current_liboctave_error_handler)
26569 0e77df67b522 Add static compile-time checking of printf functions in liboctave. Markus Mützel <markus.muetzel@gmx.de> parents: 26376 diff changeset	875 ("reshape: can't reshape %zi elements into %s array",
22139 f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	876 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	877 }
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 octave_idx_type i = 0;
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	880 for (const T& x : a)
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	881 slice_data[i++] = x;
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	882
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	883 dimensions.chop_trailing_singletons ();
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	884 }
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	885
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	886 //! 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	887 //! 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	888 //! 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	889 //! 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	890 //! 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	891 template <typename ArrayClass>
9653 e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	892 class NoAlias : public 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 typedef typename ArrayClass::element_type T;
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	895 public:
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	896 NoAlias () : ArrayClass () { }
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	897
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	898 // 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	899 template <typename X>
9653 e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	900 explicit NoAlias (X x) : ArrayClass (x) { }
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	901
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	902 template <typename X, typename Y>
9653 e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	903 explicit NoAlias (X x, Y y) : ArrayClass (x, y) { }
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	904
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	905 template <typename X, typename Y, typename Z>
9653 e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	906 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	907
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	908 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	909 { return ArrayClass::xelem (n); }
9653 e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	910 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	911 { return ArrayClass::xelem (i, j); }
9653 e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	912 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	913 { return ArrayClass::xelem (i, j, k); }
9653 e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	914 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	915 { return ArrayClass::xelem (ra_idx); }
9653 e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	916 };
e087d7c77ff9 improve linspace in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 9624 diff changeset	917
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	918 template <typename T>
9732 b4fdfee405b5 remove ArrayN<T> + fix nonhom. diag-scalar ops Jaroslav Hajek <highegg@gmail.com> parents: 9731 diff changeset	919 std::ostream&
b4fdfee405b5 remove ArrayN<T> + fix nonhom. diag-scalar ops Jaroslav Hajek <highegg@gmail.com> parents: 9731 diff changeset	920 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	921
9773 01f897d8a130 optimize memory manipulation by arrays & indexing Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	922 #endif

Mercurial > octave

annotate liboctave/array/Array.h @ 26569:0e77df67b522 stable