octave: liboctave/array/Array.h annotate

annotate liboctave/array/Array.h @ 30488:abb4823df535 stable

with C++17, match malloc/free for MEX memory (bug #61472) * Array-fwd.h, Array.h: If std::pmr::polymorphic_allocator<T> is available, use it as the default allocator for the Array<T> class. * mex.cc (fp_type_traits): New traits class and specializations. (mx_memory_resource): If std::pmr::polymorphic_allocator<T> is available, define class to manage MEX memory allocations when they are transferred to octave_value objects. (the_mx_memory_resource): New static object. (fp_to_ov): Use resource-aquiring Array constructor with a pointer to the_mx_memory_resource so that the Array object will own the allocated array and use std::free to release the storage storage allocated with mxMalloc or mxRealloc after it is returned to Octave in an octave_value object. If the polymorphic allocator is not availble (for example, compiling with a pre-c++17 compiler) then don't mix malloc with delete[] for arrays of Complex or FloatComplex objects. (int_to_ov): Set up to use the same kind of resource management as for fp_to_ov, except disable for now (we need to extend the intNDArray classes to have resource-acquiring constructors). * acinclude.m4 (OCTAVE_CHECK_STD_PMR_POLYMORPHIC_ALLOCATOR): New macro. * configure.ac: Use it. * mk-octave-config-h.sh: Insert definition for OCTAVE_CHECK_STD_PMR_POLYMORPHIC_ALLOCATOR into octave-config.h.

author	John W. Eaton <jwe@octave.org>
date	Sat, 04 Dec 2021 09:13:12 -0500
parents	298995435071
children	e9a6d3822244

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 //
29358 0a5b15007766 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27957 diff changeset	3 // Copyright (C) 1993-2021 The Octave Project Developers
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	4 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	7 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	9 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	14 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	19 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ////////////////////////////////////////////////////////////////////////
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	25
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 20232 diff changeset	26 #if ! defined (octave_Array_h)
382 e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe] jwe parents: 376 diff changeset	27 #define octave_Array_h 1
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe] jwe parents: 376 diff changeset	28
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21229 diff changeset	29 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21229 diff changeset	30
1366 f75432dff006 [project @ 1995-09-05 23:56:42 by jwe] jwe parents: 1359 diff changeset	31 #include <cassert>
4152 f14251d33b01 [project @ 2002-11-06 18:41:50 by jwe] jwe parents: 4066 diff changeset	32 #include <cstddef>
3613 0a93682f89c8 [project @ 2000-03-17 10:58:25 by jwe] jwe parents: 3585 diff changeset	33
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	34 #include <algorithm>
8950 d865363208d6 include <iosfwd> instead of <iostream> in header files John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	35 #include <iosfwd>
23443 3f1bf237908b maint: Eliminate <cfloat.h> header from liboctave files. Rik <rik@octave.org> parents: 23420 diff changeset	36 #include <string>
3933 f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3928 diff changeset	37
30429 e38202d3628d provide header file for forward declaration of Array<T> template John W. Eaton <jwe@octave.org> parents: 30394 diff changeset	38 #include "Array-fwd.h"
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	39 #include "dim-vector.h"
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	40 #include "idx-vector.h"
22139 f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	41 #include "lo-error.h"
8725 d5af326a3ede [mq]: sort-traits John W. Eaton <jwe@octave.org> parents: 8721 diff changeset	42 #include "lo-traits.h"
3613 0a93682f89c8 [project @ 2000-03-17 10:58:25 by jwe] jwe parents: 3585 diff changeset	43 #include "lo-utils.h"
23443 3f1bf237908b maint: Eliminate <cfloat.h> header from liboctave files. Rik <rik@octave.org> parents: 23420 diff changeset	44 #include "oct-refcount.h"
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7017 diff changeset	45 #include "oct-sort.h"
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	46 #include "quit.h"
7433 402168152bb9 [project @ 2008-01-31 18:59:09 by dbateman] dbateman parents: 7017 diff changeset	47
22273 91c5442ea9fd doc: doxygen explaining Array<T>. Carnë Draug <carandraug@octave.org> parents: 22139 diff changeset	48 //! 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	49 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	50 //! 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	51 //! 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	52 //! 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	53 //! 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	54 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	55 //! @code{.cc}
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	56 //! // 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	57 //! 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	58 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	59 //! // 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	60 //! A(0, 10, 3) = 2.5;
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	61 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	62 //! // 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	63 //! double v = A(1, 2, 0);
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	64 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	65 //! // 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	66 //! double v = A(24);
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	67 //! @endcode
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 //! ## Notes on STL compatibility
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 //! ### size() and length()
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	72 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	73 //! 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	74 //! 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	75 //! Octave function with same name.
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	76 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	77 //! @code{.cc}
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	78 //! 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	79 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	80 //! 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	81 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	82 //! 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	83 //! 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	84 //! 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	85 //! 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	86 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	87 //! // 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	88 //! dim_vector dims = A.dims ();
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	89 //! @endcode
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	90 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	91 //! 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	92 //! 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	93 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	94 //! 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	95 //! 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	96 //! 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	97 //! present in liboctave.
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	98 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	99 //! 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	100 //! 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	101 //! 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	102 //! 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	103 //! vectors and square matrices. The alternatives numel(), rows(),
27956 2310164737b3 fix many spelling errors (bug #57613) John W. Eaton <jwe@octave.org> parents: 26569 diff changeset	104 //! columns(), and size(d) are more explicit and recommended.
24624 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 //! ### size_type
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	107 //!
27216 823b4bcf79fc unless necessary for formatting or code, use ' instead of ` John W. Eaton <jwe@octave.org> parents: 26574 diff changeset	108 //! Array::size_type is 'octave_idx_type' which is a typedef for 'int'
823b4bcf79fc unless necessary for formatting or code, use ' instead of ` John W. Eaton <jwe@octave.org> parents: 26574 diff changeset	109 //! or 'long int', depending whether Octave was configured for 64-bit
24624 ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	110 //! indexing.
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	111 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	112 //! 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	113 //! 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	114 //! 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	115 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	116 //! ## Subclasses
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	117 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	118 //! 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	119 //! - 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	120 //! - 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	121 //! - boolNDArray: N dimensional Array<bool>
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	122 //! - ColumnVector: Array<double> with 1 column
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	123 //! - 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	124 //! - 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	125
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	126 template <typename T, typename Alloc>
3585 d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3569 diff changeset	127 class
d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3569 diff changeset	128 Array
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	129 {
3504 5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe] jwe parents: 2847 diff changeset	130 protected:
1619 1a35c8c91349 [project @ 1995-11-04 11:07:21 by jwe] jwe parents: 1574 diff changeset	131
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	132 //! The real representation of all arrays.
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	133 class ArrayRep : public Alloc
1735 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 public:
d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	136
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	137 typedef std::allocator_traits<Alloc> Alloc_traits;
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	138
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	139 typedef typename Alloc_traits::rebind_traits<T> T_Alloc_traits;
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	140 typedef typename T_Alloc_traits::pointer pointer;
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	141
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	142 pointer m_data;
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	143 octave_idx_type m_len;
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	144 octave::refcount<octave_idx_type> m_count;
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	145
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	146 ArrayRep (pointer d, octave_idx_type len)
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	147 : Alloc (), m_data (allocate (len)), m_len (len), m_count (1)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	148 {
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	149 std::copy_n (d, len, m_data);
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	150 }
10364 96ed7c629bbd remove dangerous pointer-acquiring Array ctors Jaroslav Hajek <highegg@gmail.com> parents: 10358 diff changeset	151
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	152 template <typename U>
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	153 ArrayRep (U *d, octave_idx_type len)
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	154 : Alloc (), m_data (allocate (len)), m_len (len), m_count (1)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	155 {
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	156 std::copy_n (d, len, m_data);
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	157 }
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	158
23401 e0c20a22da7e eliminate some errors exposed by -fsanitize=undefined John W. Eaton <jwe@octave.org> parents: 23386 diff changeset	159 // 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	160 // 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	161
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	162 ArrayRep (void)
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	163 : Alloc (), m_data (allocate (0)), m_len (0), m_count (1) { }
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	164
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	165 explicit ArrayRep (octave_idx_type len)
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	166 : Alloc (), m_data (allocate (len)), m_len (len), m_count (1) { }
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	167
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	168 explicit ArrayRep (octave_idx_type len, const T& val)
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	169 : Alloc (), m_data (allocate (len)), m_len (len), m_count (1)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	170 {
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	171 std::fill_n (m_data, len, val);
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	172 }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	173
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	174 explicit ArrayRep (pointer ptr, const dim_vector& dv,
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	175 const Alloc& xallocator = Alloc ())
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	176 : Alloc (xallocator), m_data (ptr), m_len (dv.safe_numel ()), m_count (1)
30227 b00ff462e0f2 improve efficiency of mxArray -> octave_value conversion John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	177 { }
b00ff462e0f2 improve efficiency of mxArray -> octave_value conversion John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	178
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	179 // FIXME: Should the allocator be copied or created with the default?
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	180 ArrayRep (const ArrayRep& a)
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	181 : Alloc (), m_data (allocate (a.m_len)), m_len (a.m_len),
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	182 m_count (1)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	183 {
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	184 std::copy_n (a.m_data, a.m_len, m_data);
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	185 }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	186
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	187 ~ArrayRep (void) { deallocate (m_data, m_len); }
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	188
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	189 octave_idx_type numel (void) const { return m_len; }
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	190
4517 b4449b1193ac [project @ 2003-09-20 02:06:06 by jwe] jwe parents: 4513 diff changeset	191 // No assignment!
b4449b1193ac [project @ 2003-09-20 02:06:06 by jwe] jwe parents: 4513 diff changeset	192
29946 3e5e88d9c85f tag ArrayRep copy assignment operator with =delete John W. Eaton <jwe@octave.org> parents: 29937 diff changeset	193 ArrayRep& operator = (const ArrayRep&) = delete;
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	194
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	195 pointer allocate (size_t len)
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	196 {
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	197 pointer data = Alloc_traits::allocate (*this, len);
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	198 for (size_t i = 0; i < len; i++)
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	199 T_Alloc_traits::construct (*this, data+i);
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	200 return data;
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	201 }
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	202
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	203 void deallocate (pointer data, size_t len)
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	204 {
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	205 for (size_t i = 0; i < len; i++)
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	206 T_Alloc_traits::destroy (*this, data+i);
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	207 Alloc_traits::deallocate (*this, data, len);
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	208 }
1735 d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	209 };
d2ee993d40cd [project @ 1996-01-12 07:46:09 by jwe] jwe parents: 1703 diff changeset	210
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	211 //--------------------------------------------------------------------
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	212
6884 1cbb8b606d63 [project @ 2007-09-10 20:43:26 by jwe] jwe parents: 6881 diff changeset	213 public:
1cbb8b606d63 [project @ 2007-09-10 20:43:26 by jwe] jwe parents: 6881 diff changeset	214
9556 948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	215 void make_unique (void)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	216 {
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	217 if (m_rep->m_count > 1)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	218 {
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	219 ArrayRep *r = new ArrayRep (m_slice_data, m_slice_len);
13985 43cc49c7abd1 Use thread-safe atomic reference counting (GCC and MSVC). Michael Goffioul <michael.goffioul@gmail.com> parents: 12125 diff changeset	220
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	221 if (--m_rep->m_count == 0)
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	222 delete m_rep;
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	223
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	224 m_rep = r;
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	225 m_slice_data = m_rep->m_data;
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	226 }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	227 }
238 780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe] jwe parents: 228 diff changeset	228
5900 c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe] jwe parents: 5775 diff changeset	229 typedef T element_type;
c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe] jwe parents: 5775 diff changeset	230
22279 3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	231 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	232
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	233 //! 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	234 //! (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	235 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	236
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	237 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	238
8725 d5af326a3ede [mq]: sort-traits John W. Eaton <jwe@octave.org> parents: 8721 diff changeset	239 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	240 typename ref_param<T>::type);
8725 d5af326a3ede [mq]: sort-traits John W. Eaton <jwe@octave.org> parents: 8721 diff changeset	241
8524 937921654627 clean up Array and DiagArray2 Jaroslav Hajek <highegg@gmail.com> parents: 8523 diff changeset	242 protected:
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: 4834 diff changeset	243
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	244 dim_vector m_dimensions;
4518 382cb0ed8c14 [project @ 2003-09-20 18:08:40 by jwe] jwe parents: 4517 diff changeset	245
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	246 typename Array<T, Alloc>::ArrayRep *m_rep;
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	247
8531 b01fef323c24 add some explaining comments Jaroslav Hajek <highegg@gmail.com> parents: 8524 diff changeset	248 // Rationale:
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	249 // m_slice_data is a pointer to m_rep->m_data, denoting together with m_slice_len the
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	250 // 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	251 // allows to make shallow copies not only of a whole array, but also of
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	252 // contiguous subranges. Every time m_rep is directly manipulated, m_slice_data
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	253 // and m_slice_len need to be properly updated.
8531 b01fef323c24 add some explaining comments Jaroslav Hajek <highegg@gmail.com> parents: 8524 diff changeset	254
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	255 T *m_slice_data;
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	256 octave_idx_type m_slice_len;
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	257
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	258 //! slice constructor
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	259 Array (const Array<T, Alloc>& a, const dim_vector& dv,
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	260 octave_idx_type l, octave_idx_type u)
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	261 : m_dimensions (dv), m_rep(a.m_rep), m_slice_data (a.m_slice_data+l), m_slice_len (u-l)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	262 {
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	263 m_rep->m_count++;
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	264 m_dimensions.chop_trailing_singletons ();
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	265 }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	266
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	267 private:
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	268
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	269 static OCTARRAY_API typename Array<T, Alloc>::ArrayRep *nil_rep (void);
238 780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe] jwe parents: 228 diff changeset	270
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	271 public:
238 780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe] jwe parents: 228 diff changeset	272
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	273 //! Empty ctor (0 by 0).
1550 d89532de8e72 [project @ 1995-10-08 01:12:20 by jwe] jwe parents: 1366 diff changeset	274 Array (void)
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	275 : m_dimensions (), m_rep (nil_rep ()), m_slice_data (m_rep->m_data),
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	276 m_slice_len (m_rep->m_len)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	277 {
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	278 m_rep->m_count++;
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	279 }
1550 d89532de8e72 [project @ 1995-10-08 01:12:20 by jwe] jwe parents: 1366 diff changeset	280
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	281 //! nD uninitialized ctor.
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	282 explicit Array (const dim_vector& dv)
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	283 : m_dimensions (dv),
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	284 m_rep (new typename Array<T, Alloc>::ArrayRep (dv.safe_numel ())),
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	285 m_slice_data (m_rep->m_data), m_slice_len (m_rep->m_len)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	286 {
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	287 m_dimensions.chop_trailing_singletons ();
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	288 }
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	289
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	290 //! nD initialized ctor.
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	291 explicit Array (const dim_vector& dv, const T& val)
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	292 : m_dimensions (dv),
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	293 m_rep (new typename Array<T, Alloc>::ArrayRep (dv.safe_numel ())),
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	294 m_slice_data (m_rep->m_data), m_slice_len (m_rep->m_len)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	295 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	296 fill (val);
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	297 m_dimensions.chop_trailing_singletons ();
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	298 }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	299
30227 b00ff462e0f2 improve efficiency of mxArray -> octave_value conversion John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	300 // Construct an Array from a pointer to an externally allocated array
b00ff462e0f2 improve efficiency of mxArray -> octave_value conversion John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	301 // of values. PTR must be allocated with operator new. The Array
b00ff462e0f2 improve efficiency of mxArray -> octave_value conversion John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	302 // object takes ownership of PTR and will delete it when the Array
b00ff462e0f2 improve efficiency of mxArray -> octave_value conversion John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	303 // object is deleted. The dimension vector DV must be consistent with
b00ff462e0f2 improve efficiency of mxArray -> octave_value conversion John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	304 // the size of the allocated PTR array.
b00ff462e0f2 improve efficiency of mxArray -> octave_value conversion John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	305
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	306 explicit Array (T *ptr, const dim_vector& dv,
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	307 const Alloc& xallocator = Alloc ())
30227 b00ff462e0f2 improve efficiency of mxArray -> octave_value conversion John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	308 : m_dimensions (dv),
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	309 m_rep (new typename Array<T, Alloc>::ArrayRep (ptr, dv, xallocator)),
30227 b00ff462e0f2 improve efficiency of mxArray -> octave_value conversion John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	310 m_slice_data (m_rep->m_data), m_slice_len (m_rep->m_len)
b00ff462e0f2 improve efficiency of mxArray -> octave_value conversion John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	311 {
b00ff462e0f2 improve efficiency of mxArray -> octave_value conversion John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	312 m_dimensions.chop_trailing_singletons ();
b00ff462e0f2 improve efficiency of mxArray -> octave_value conversion John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	313 }
b00ff462e0f2 improve efficiency of mxArray -> octave_value conversion John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	314
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	315 //! Reshape constructor.
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	316 OCTARRAY_API Array (const Array<T, Alloc>& a, const dim_vector& dv);
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	317
22139 f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	318 //! 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	319 template<template <typename...> class Container>
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	320 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	321
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	322 //! Type conversion case.
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	323 template <typename U, typename A = Alloc>
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	324 Array (const Array<U, A>& a)
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	325 : m_dimensions (a.dims ()),
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	326 m_rep (new typename Array<T, Alloc>::ArrayRep (a.data (), a.numel ())),
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	327 m_slice_data (m_rep->m_data), m_slice_len (m_rep->m_len)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	328 { }
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: 4834 diff changeset	329
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	330 //! No type conversion case.
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	331 Array (const Array<T, Alloc>& a)
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	332 : m_dimensions (a.m_dimensions), m_rep (a.m_rep), m_slice_data (a.m_slice_data),
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	333 m_slice_len (a.m_slice_len)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	334 {
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	335 m_rep->m_count++;
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	336 }
1550 d89532de8e72 [project @ 1995-10-08 01:12:20 by jwe] jwe parents: 1366 diff changeset	337
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	338 Array (Array<T, Alloc>&& a)
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	339 : m_dimensions (std::move (a.m_dimensions)), m_rep (a.m_rep),
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	340 m_slice_data (a.m_slice_data), m_slice_len (a.m_slice_len)
27352 7335ebd4c798 define some move constructors and assignment operators John W. Eaton <jwe@octave.org> parents: 27216 diff changeset	341 {
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	342 a.m_rep = nullptr;
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	343 a.m_slice_data = nullptr;
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	344 a.m_slice_len = 0;
27352 7335ebd4c798 define some move constructors and assignment operators John W. Eaton <jwe@octave.org> parents: 27216 diff changeset	345 }
7335ebd4c798 define some move constructors and assignment operators John W. Eaton <jwe@octave.org> parents: 27216 diff changeset	346
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	347 public:
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	348
15216 dd7c37ceb800 avoid GCC warning by declaring Array destructor virtual John W. Eaton <jwe@octave.org> parents: 15212 diff changeset	349 virtual ~Array (void)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	350 {
27352 7335ebd4c798 define some move constructors and assignment operators John W. Eaton <jwe@octave.org> parents: 27216 diff changeset	351 // Because we define a move constructor and a move assignment
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	352 // operator, m_rep may be a nullptr here. We should only need to
27352 7335ebd4c798 define some move constructors and assignment operators John W. Eaton <jwe@octave.org> parents: 27216 diff changeset	353 // protect the move assignment operator in a similar way.
7335ebd4c798 define some move constructors and assignment operators John W. Eaton <jwe@octave.org> parents: 27216 diff changeset	354
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	355 if (m_rep && --m_rep->m_count == 0)
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	356 delete m_rep;
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	357 }
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	358
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	359 Array<T, Alloc>& operator = (const Array<T, Alloc>& a)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	360 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	361 if (this != &a)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	362 {
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	363 if (--m_rep->m_count == 0)
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	364 delete m_rep;
9556 948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	365
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	366 m_rep = a.m_rep;
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	367 m_rep->m_count++;
9556 948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	368
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	369 m_dimensions = a.m_dimensions;
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	370 m_slice_data = a.m_slice_data;
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	371 m_slice_len = a.m_slice_len;
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	372 }
9556 948795dc1974 make a few Array methods inline Jaroslav Hajek <highegg@gmail.com> parents: 9546 diff changeset	373
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	374 return *this;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	375 }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	376
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	377 Array<T, Alloc>& operator = (Array<T, Alloc>&& a)
27352 7335ebd4c798 define some move constructors and assignment operators John W. Eaton <jwe@octave.org> parents: 27216 diff changeset	378 {
7335ebd4c798 define some move constructors and assignment operators John W. Eaton <jwe@octave.org> parents: 27216 diff changeset	379 if (this != &a)
7335ebd4c798 define some move constructors and assignment operators John W. Eaton <jwe@octave.org> parents: 27216 diff changeset	380 {
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	381 m_dimensions = std::move (a.m_dimensions);
27352 7335ebd4c798 define some move constructors and assignment operators John W. Eaton <jwe@octave.org> parents: 27216 diff changeset	382
7335ebd4c798 define some move constructors and assignment operators John W. Eaton <jwe@octave.org> parents: 27216 diff changeset	383 // Because we define a move constructor and a move assignment
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	384 // operator, m_rep may be a nullptr here. We should only need to
27352 7335ebd4c798 define some move constructors and assignment operators John W. Eaton <jwe@octave.org> parents: 27216 diff changeset	385 // protect the destructor in a similar way.
7335ebd4c798 define some move constructors and assignment operators John W. Eaton <jwe@octave.org> parents: 27216 diff changeset	386
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	387 if (m_rep && --m_rep->m_count == 0)
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	388 delete m_rep;
27352 7335ebd4c798 define some move constructors and assignment operators John W. Eaton <jwe@octave.org> parents: 27216 diff changeset	389
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	390 m_rep = a.m_rep;
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	391 m_slice_data = a.m_slice_data;
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	392 m_slice_len = a.m_slice_len;
27352 7335ebd4c798 define some move constructors and assignment operators John W. Eaton <jwe@octave.org> parents: 27216 diff changeset	393
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	394 a.m_rep = nullptr;
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	395 a.m_slice_data = nullptr;
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	396 a.m_slice_len = 0;
27352 7335ebd4c798 define some move constructors and assignment operators John W. Eaton <jwe@octave.org> parents: 27216 diff changeset	397 }
7335ebd4c798 define some move constructors and assignment operators John W. Eaton <jwe@octave.org> parents: 27216 diff changeset	398
7335ebd4c798 define some move constructors and assignment operators John W. Eaton <jwe@octave.org> parents: 27216 diff changeset	399 return *this;
7335ebd4c798 define some move constructors and assignment operators John W. Eaton <jwe@octave.org> parents: 27216 diff changeset	400 }
7335ebd4c798 define some move constructors and assignment operators John W. Eaton <jwe@octave.org> parents: 27216 diff changeset	401
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	402 OCTARRAY_API void fill (const T& val);
9624 3fc7272937ce implement Array<T>::clear overloads Jaroslav Hajek <highegg@gmail.com> parents: 9556 diff changeset	403
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	404 OCTARRAY_API void clear (void);
cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	405 OCTARRAY_API void clear (const dim_vector& dv);
9624 3fc7272937ce implement Array<T>::clear overloads Jaroslav Hajek <highegg@gmail.com> parents: 9556 diff changeset	406
3fc7272937ce implement Array<T>::clear overloads Jaroslav Hajek <highegg@gmail.com> parents: 9556 diff changeset	407 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	408 { clear (dim_vector (r, c)); }
238 780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe] jwe parents: 228 diff changeset	409
20212 6af35d4f1ba4 doxygen: document Array::length() and similar methods (bug #45138) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	410 //! Number of elements in the array.
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	411 octave_idx_type numel (void) const { return m_slice_len; }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	412 //@}
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	413
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	414 //! Return the array as a column vector.
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	415 Array<T, Alloc> as_column (void) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	416 {
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	417 Array<T, Alloc> retval (*this);
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	418 if (m_dimensions.ndims () != 2 \|\| m_dimensions(1) != 1)
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	419 retval.m_dimensions = dim_vector (numel (), 1);
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	420
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	421 return retval;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	422 }
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	423
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	424 //! Return the array as a row vector.
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	425 Array<T, Alloc> as_row (void) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	426 {
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	427 Array<T, Alloc> retval (*this);
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	428 if (m_dimensions.ndims () != 2 \|\| m_dimensions(0) != 1)
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	429 retval.m_dimensions = dim_vector (1, numel ());
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	430
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	431 return retval;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	432 }
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	433
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	434 //! Return the array as a matrix.
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	435 Array<T, Alloc> as_matrix (void) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	436 {
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	437 Array<T, Alloc> retval (*this);
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	438 if (m_dimensions.ndims () != 2)
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	439 retval.m_dimensions = m_dimensions.redim (2);
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	440
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	441 return retval;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	442 }
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	443
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	444 //! @name First dimension
19330 1f4455ff2329 Remove deprecated methods in liboctave. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19326 diff changeset	445 //!
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	446 //! 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	447 //@{
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	448 octave_idx_type dim1 (void) const { return m_dimensions(0); }
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	449 octave_idx_type rows (void) const { return dim1 (); }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	450 //@}
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	451
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	452 //! @name Second dimension
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	453 //!
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	454 //! 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	455 //@{
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	456 octave_idx_type dim2 (void) const { return m_dimensions(1); }
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	457 octave_idx_type cols (void) const { return dim2 (); }
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	458 octave_idx_type columns (void) const { return dim2 (); }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	459 //@}
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	460
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	461 //! @name Third dimension
19330 1f4455ff2329 Remove deprecated methods in liboctave. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19326 diff changeset	462 //!
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	463 //! 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	464 //@{
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	465 octave_idx_type dim3 (void) const { return m_dimensions(2); }
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	466 octave_idx_type pages (void) const { return dim3 (); }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	467 //@}
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	468
22279 3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	469 //! Size of the specified dimension.
24624 ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	470 //!
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	471 //! 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	472 //! those are implicit singleton dimensions.
ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	473 //!
27216 823b4bcf79fc unless necessary for formatting or code, use ' instead of ` John W. Eaton <jwe@octave.org> parents: 26574 diff changeset	474 //! 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	475
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	476 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	477 {
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	478 // 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	479 // Should >= ndims () be handled by dim_vector operator() instead ?
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	480 return d >= ndims () ? 1 : m_dimensions(d);
22279 3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	481 }
3bb1dc8b723e Array: new typedef size_type and value_type, and new method size(dimension). Carnë Draug <carandraug@octave.org> parents: 22276 diff changeset	482
29654 d13d090cb03a use std::size_t and std::ptrdiff_t in C++ code (bug #60471) John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	483 std::size_t byte_size (void) const
d13d090cb03a use std::size_t and std::ptrdiff_t in C++ code (bug #60471) John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	484 { return static_cast<std::size_t> (numel ()) * sizeof (T); }
4902 bd043a433918 [project @ 2004-06-14 18:46:20 by jwe] jwe parents: 4834 diff changeset	485
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	486 //! Return a const-reference so that dims ()(i) works efficiently.
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	487 const dim_vector& dims (void) const { return m_dimensions; }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	488
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	489 //! Chop off leading singleton dimensions
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	490 OCTARRAY_API Array<T, Alloc> squeeze (void) const;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	491
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	492 OCTARRAY_API octave_idx_type compute_index (octave_idx_type i, octave_idx_type j) const;
cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	493 OCTARRAY_API octave_idx_type compute_index (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	494 octave_idx_type k) const;
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	495 OCTARRAY_API 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	496
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	497 octave_idx_type compute_index_unchecked (const Array<octave_idx_type>& ra_idx) const
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	498 {
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	499 return m_dimensions.compute_index (ra_idx.data (), ra_idx.numel ());
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	500 }
10645 8645b7087859 abstract scalar index checking off Array<T> (prep for struct optimizations) Jaroslav Hajek <highegg@gmail.com> parents: 10636 diff changeset	501
2108 2b67abb63030 [project @ 1996-04-30 10:44:17 by jwe] jwe parents: 2049 diff changeset	502 // No checking, even for multiple references, ever.
2b67abb63030 [project @ 1996-04-30 10:44:17 by jwe] jwe parents: 2049 diff changeset	503
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	504 T& xelem (octave_idx_type n) { return m_slice_data[n]; }
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	505 crefT xelem (octave_idx_type n) const { return m_slice_data[n]; }
2108 2b67abb63030 [project @ 1996-04-30 10:44:17 by jwe] jwe parents: 2049 diff changeset	506
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	507 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	508 { return xelem (dim1 ()*j+i); }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	509 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	510 { return xelem (dim1 ()*j+i); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	511
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	512 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	513 { return xelem (i, dim2 ()*k+j); }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	514 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	515 { return xelem (i, dim2 ()*k+j); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	516
6867 83619ae96c1d [project @ 2007-09-06 12:08:44 by dbateman] dbateman parents: 6708 diff changeset	517 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	518 { return xelem (compute_index_unchecked (ra_idx)); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	519
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	520 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	521 { return xelem (compute_index_unchecked (ra_idx)); }
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 // 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	524 // 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	525
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	526 OCTARRAY_API T& checkelem (octave_idx_type n);
23487 af2f1f3dbe06 eliminate --enable-bounds-check configure option John W. Eaton <jwe@octave.org> parents: 23461 diff changeset	527
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	528 OCTARRAY_API 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	529
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	530 OCTARRAY_API 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	531
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	532 OCTARRAY_API 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	533
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	534 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	535 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	536 make_unique ();
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	537 return xelem (n);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	538 }
2306 2fbf9bb1cd7a [project @ 1996-07-09 16:49:03 by jwe] jwe parents: 2109 diff changeset	539
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	540 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	541
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	542 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	543 { return elem (i, dim2 ()*k+j); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	544
6867 83619ae96c1d [project @ 2007-09-06 12:08:44 by dbateman] dbateman parents: 6708 diff changeset	545 T& elem (const Array<octave_idx_type>& ra_idx)
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	546 { return Array<T, Alloc>::elem (compute_index_unchecked (ra_idx)); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	547
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	548 T& operator () (octave_idx_type n) { return elem (n); }
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	549 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	550 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	551 { return elem (i, j, k); }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	552 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	553 { return elem (ra_idx); }
2006 95e952f72d66 [project @ 1996-03-04 00:33:32 by jwe] jwe parents: 2005 diff changeset	554
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	555 OCTARRAY_API 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	556
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	557 OCTARRAY_API 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	558
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	559 OCTARRAY_API crefT checkelem (octave_idx_type i, octave_idx_type j,
30394 f3f3e3793fb5 maint: style check C++ files in liboctave/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30232 diff changeset	560 octave_idx_type k) const;
23487 af2f1f3dbe06 eliminate --enable-bounds-check configure option John W. Eaton <jwe@octave.org> parents: 23461 diff changeset	561
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	562 OCTARRAY_API 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	563
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	564 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	565
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	566 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	567 { return xelem (i, j); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	568
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	569 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	570 { return xelem (i, j, k); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	571
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	572 crefT elem (const Array<octave_idx_type>& ra_idx) const
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	573 { return Array<T, Alloc>::xelem (compute_index_unchecked (ra_idx)); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	574
10075 84b0725f4b09 return class types by reference in const Array element access functions Jaroslav Hajek <highegg@gmail.com> parents: 9921 diff changeset	575 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	576 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	577 { return elem (i, j); }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	578 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	579 octave_idx_type k) const
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	580 { return elem (i, j, k); }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	581 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	582 { return elem (ra_idx); }
2006 95e952f72d66 [project @ 1996-03-04 00:33:32 by jwe] jwe parents: 2005 diff changeset	583
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	584 // Fast extractors. All of these produce shallow copies.
9731 7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	585
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	586 //! Extract column: A(:,k+1).
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	587 OCTARRAY_API Array<T, Alloc> column (octave_idx_type k) const;
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	588 //! Extract page: A(:,:,k+1).
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	589 OCTARRAY_API Array<T, Alloc> page (octave_idx_type k) const;
9731 7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	590
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	591 //! 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	592 //! Must be 0 <= lo && up <= numel. May be up < lo.
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	593 OCTARRAY_API Array<T, Alloc> linear_slice (octave_idx_type lo, octave_idx_type up) const;
9731 7b9cbaad68d6 extend Array<T> Jaroslav Hajek <highegg@gmail.com> parents: 9725 diff changeset	594
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	595 Array<T, Alloc> reshape (octave_idx_type nr, octave_idx_type nc) const
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	596 { return Array<T, Alloc> (*this, dim_vector (nr, nc)); }
10352 a3635bc1ea19 remove Array2 Jaroslav Hajek <highegg@gmail.com> parents: 10350 diff changeset	597
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	598 Array<T, Alloc> reshape (const dim_vector& new_dims) const
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	599 { return Array<T, Alloc> (*this, new_dims); }
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4559 diff changeset	600
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	601 OCTARRAY_API Array<T, Alloc> permute (const Array<octave_idx_type>& vec, bool inv = false) const;
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	602 Array<T, Alloc> 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	603 { return permute (vec, true); }
4593 77566be8b9e9 [project @ 2003-11-11 17:25:42 by jwe] jwe parents: 4587 diff changeset	604
23593 a8361bc2361a maint: Deprecate is_square and replace with issquare. Rik <rik@octave.org> parents: 23592 diff changeset	605 bool issquare (void) const { return (dim1 () == dim2 ()); }
a8361bc2361a maint: Deprecate is_square and replace with issquare. Rik <rik@octave.org> parents: 23592 diff changeset	606
23577 80c42f4cca13 maint: Deprecate is_empty and replace with isempty. Rik <rik@octave.org> parents: 23487 diff changeset	607 bool isempty (void) const { return numel () == 0; }
80c42f4cca13 maint: Deprecate is_empty and replace with isempty. Rik <rik@octave.org> parents: 23487 diff changeset	608
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	609 bool isvector (void) const { return m_dimensions.isvector (); }
23592 80e3bfb7bd5a maint: Deprecate is_vector and replace with isvector. Rik <rik@octave.org> parents: 23588 diff changeset	610
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	611 bool is_nd_vector (void) const { return m_dimensions.is_nd_vector (); }
23386 f1ea44e92df8 improve compatibility for single index indexing (bug #50776) John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	612
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	613 OCTARRAY_API Array<T, Alloc> transpose (void) const;
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	614 OCTARRAY_API Array<T, Alloc> hermitian (T (*fcn) (const T&) = nullptr) const;
238 780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe] jwe parents: 228 diff changeset	615
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	616 const T * data (void) const { return m_slice_data; }
228 ee01ac1c7acc [project @ 1993-11-16 09:56:54 by jwe] jwe parents: diff changeset	617
29954 4c88a452519c rename OCTAVE_USE_DEPRECATED_FUNCTIONS macro and attempt to make it work John W. Eaton <jwe@octave.org> parents: 29949 diff changeset	618 #if defined (OCTAVE_PROVIDE_DEPRECATED_SYMBOLS)
29931 7faff48840eb prefer data over fortran_vec for read-only access to data John W. Eaton <jwe@octave.org> parents: 29887 diff changeset	619 OCTAVE_DEPRECATED (7, "for read-only access, use 'data' method instead")
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23443 diff changeset	620 const T * fortran_vec (void) const { return data (); }
29954 4c88a452519c rename OCTAVE_USE_DEPRECATED_FUNCTIONS macro and attempt to make it work John W. Eaton <jwe@octave.org> parents: 29949 diff changeset	621 #endif
3952 945e8c160191 [project @ 2002-05-23 17:18:12 by jwe] jwe parents: 3944 diff changeset	622
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	623 OCTARRAY_API T * fortran_vec (void);
1560 27a03373de41 [project @ 1995-10-12 07:22:26 by jwe] jwe parents: 1550 diff changeset	624
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	625 bool is_shared (void) { return m_rep->m_count > 1; }
9546 1beb23d2b892 optimize op= in common cases Jaroslav Hajek <highegg@gmail.com> parents: 9341 diff changeset	626
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	627 int ndims (void) const { return m_dimensions.ndims (); }
1560 27a03373de41 [project @ 1995-10-12 07:22:26 by jwe] jwe parents: 1550 diff changeset	628
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	629 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	630 //! Indexing without resizing.
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	631 OCTARRAY_API Array<T, Alloc> index (const octave::idx_vector& i) const;
1560 27a03373de41 [project @ 1995-10-12 07:22:26 by jwe] jwe parents: 1550 diff changeset	632
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	633 OCTARRAY_API Array<T, Alloc> index (const octave::idx_vector& i, const octave::idx_vector& j) const;
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	634
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	635 OCTARRAY_API Array<T, Alloc> index (const Array<octave::idx_vector>& ia) const;
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	636 //@}
1560 27a03373de41 [project @ 1995-10-12 07:22:26 by jwe] jwe parents: 1550 diff changeset	637
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	638 virtual OCTARRAY_API T resize_fill_value (void) const;
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	639
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	640 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	641 //! Resizing (with fill).
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	642 OCTARRAY_API void resize2 (octave_idx_type nr, octave_idx_type nc, const T& rfv);
19330 1f4455ff2329 Remove deprecated methods in liboctave. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19326 diff changeset	643 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	644 {
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	645 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	646 }
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	647
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	648 OCTARRAY_API void resize1 (octave_idx_type n, const T& rfv);
19330 1f4455ff2329 Remove deprecated methods in liboctave. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 19326 diff changeset	649 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	650
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	651 OCTARRAY_API void resize (const dim_vector& dv, const T& rfv);
14616 13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	652 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	653 //@}
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	654
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	655 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	656 //! Indexing with possible resizing and fill
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	657
19861 19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	658 // 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	659 // handled directly in liboctinterp.
3933 f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3928 diff changeset	660
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	661 OCTARRAY_API Array<T, Alloc> index (const octave::idx_vector& i, bool resize_ok, const T& rfv) const;
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	662 Array<T, Alloc> index (const octave::idx_vector& i, 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	663 {
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	664 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	665 }
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	666
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	667 OCTARRAY_API Array<T, Alloc> index (const octave::idx_vector& i, const octave::idx_vector& j,
30394 f3f3e3793fb5 maint: style check C++ files in liboctave/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30232 diff changeset	668 bool resize_ok,
f3f3e3793fb5 maint: style check C++ files in liboctave/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30232 diff changeset	669 const T& rfv) const;
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	670 Array<T, Alloc> index (const octave::idx_vector& i, const octave::idx_vector& j,
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	671 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	672 {
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	673 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	674 }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	675
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	676 OCTARRAY_API Array<T, Alloc> index (const Array<octave::idx_vector>& ia, bool resize_ok,
30394 f3f3e3793fb5 maint: style check C++ files in liboctave/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30232 diff changeset	677 const T& rfv) const;
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	678 Array<T, Alloc> index (const Array<octave::idx_vector>& ia, 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	679 {
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	680 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	681 }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	682 //@}
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	683
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	684 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	685 //! Indexed assignment (always with resize & fill).
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	686 OCTARRAY_API void assign (const octave::idx_vector& i, const Array<T, Alloc>& rhs, const T& rfv);
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	687 void assign (const octave::idx_vector& i, const Array<T, Alloc>& rhs)
14616 13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	688 {
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	689 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	690 }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	691
30394 f3f3e3793fb5 maint: style check C++ files in liboctave/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30232 diff changeset	692 OCTARRAY_API void assign (const octave::idx_vector& i, const octave::idx_vector& j,
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	693 const Array<T, Alloc>& rhs,
30394 f3f3e3793fb5 maint: style check C++ files in liboctave/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30232 diff changeset	694 const T& rfv);
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	695 void assign (const octave::idx_vector& i, const octave::idx_vector& j, const Array<T, Alloc>& rhs)
14616 13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	696 {
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	697 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	698 }
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	699
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	700 OCTARRAY_API void assign (const Array<octave::idx_vector>& ia, const Array<T, Alloc>& rhs, const T& rfv);
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	701 void assign (const Array<octave::idx_vector>& ia, const Array<T, Alloc>& rhs)
14616 13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	702 {
13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14557 diff changeset	703 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	704 }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	705 //@}
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	706
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	707 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	708 //! Deleting elements.
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	709
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	710 //! A(I) = [] (with a single subscript)
29569 29a1f8fd8ee6 move idx_vector classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	711 OCTARRAY_API void delete_elements (const octave::idx_vector& i);
4530 e8d87fefd144 [project @ 2003-10-07 04:02:04 by jwe] jwe parents: 4518 diff changeset	712
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	713 //! A(:,...,I,...,:) = [] (>= 2 subscripts, one of them is non-colon)
29569 29a1f8fd8ee6 move idx_vector classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	714 OCTARRAY_API void delete_elements (int dim, const octave::idx_vector& i);
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 8179 diff changeset	715
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	716 //! Dispatcher to the above two.
29569 29a1f8fd8ee6 move idx_vector classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	717 OCTARRAY_API void delete_elements (const Array<octave::idx_vector>& ia);
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	718 //@}
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	719
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	720 //! 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	721 //! 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	722 //! 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	723 //! iN:iN+dN-1) = a.
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	724 OCTARRAY_API Array<T, Alloc>& insert (const Array<T, Alloc>& a, const Array<octave_idx_type>& idx);
3928 e8627dc4bdf2 [project @ 2002-05-03 19:56:01 by jwe] jwe parents: 3836 diff changeset	725
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	726 //! This is just a special case for idx = [r c 0 ...]
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	727 OCTARRAY_API Array<T, Alloc>& insert (const Array<T, Alloc>& 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	728
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	729 void maybe_economize (void)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	730 {
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	731 if (m_rep->m_count == 1 && m_slice_len != m_rep->m_len)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	732 {
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	733 ArrayRep *new_rep = new ArrayRep (m_slice_data, m_slice_len);
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	734 delete m_rep;
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	735 m_rep = new_rep;
be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	736 m_slice_data = m_rep->m_data;
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	737 }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	738 }
8523 ad3afaaa19c1 implement non-copying contiguous range indexing Jaroslav Hajek <highegg@gmail.com> parents: 8503 diff changeset	739
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	740 OCTARRAY_API 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	741
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	742 OCTARRAY_API Array<T, Alloc> sort (int dim = 0, sortmode mode = ASCENDING) const;
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	743 OCTARRAY_API Array<T, Alloc> sort (Array<octave_idx_type>& sidx, int dim = 0,
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	744 sortmode mode = ASCENDING) const;
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	745
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	746 //! Ordering is auto-detected or can be specified.
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	747 OCTARRAY_API sortmode issorted (sortmode mode = UNSORTED) const;
23588 0549061d35b9 maint: Deprecate is_sorted and replace with issorted. Rik <rik@octave.org> parents: 23577 diff changeset	748
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	749 //! Sort by rows returns only indices.
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	750 OCTARRAY_API Array<octave_idx_type> sort_rows_idx (sortmode mode = ASCENDING) const;
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8700 diff changeset	751
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	752 //! Ordering is auto-detected or can be specified.
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	753 OCTARRAY_API sortmode is_sorted_rows (sortmode mode = UNSORTED) const;
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8700 diff changeset	754
24624 ce2eb28e0a6d doc: make all Doxygen comment blocks more consistent Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	755 //! 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	756 //! Mode can be specified or is auto-detected by comparing 1st and last element.
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	757 OCTARRAY_API octave_idx_type lookup (const T& value, sortmode mode = UNSORTED) const;
8814 de16ebeef93d improve lookup, provide Array<T>::lookup Jaroslav Hajek <highegg@gmail.com> parents: 8725 diff changeset	758
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	759 //! 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	760 //! are sorted. NaNs get the value N.
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	761 OCTARRAY_API Array<octave_idx_type> lookup (const Array<T, Alloc>& values,
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	762 sortmode mode = UNSORTED) const;
9341 9fd5c56ce57a extend lookup capabilities Jaroslav Hajek <highegg@gmail.com> parents: 9201 diff changeset	763
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	764 //! Count nonzero elements.
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	765 OCTARRAY_API octave_idx_type nnz (void) const;
9878 ead4f9c82a9a implement Array<T>::nnz Jaroslav Hajek <highegg@gmail.com> parents: 9840 diff changeset	766
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	767 //! 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	768 //! backward specifies search from backward.
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	769 OCTARRAY_API Array<octave_idx_type> find (octave_idx_type n = -1,
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	770 bool backward = false) const;
9025 484756d558d6 add Array<T>::find Jaroslav Hajek <highegg@gmail.com> parents: 8998 diff changeset	771
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	772 //! 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	773 //! 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	774 //! contiguous range.
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	775 OCTARRAY_API Array<T, Alloc> nth_element (const octave::idx_vector& n, int dim = 0) const;
9725 aea3a3a950e1 implement nth_element Jaroslav Hajek <highegg@gmail.com> parents: 9653 diff changeset	776
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	777 //! 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	778 //! ordinary diagonal.
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	779 OCTARRAY_API Array<T, Alloc> diag (octave_idx_type k = 0) const;
7620 36594d5bbe13 Move diag function into the octave_value class David Bateman <dbateman@free.fr> parents: 7503 diff changeset	780
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	781 OCTARRAY_API Array<T, Alloc> diag (octave_idx_type m, octave_idx_type n) const;
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	782
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	783 //! 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	784 //! 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	785 //! 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	786 //! vertcat/horzcat.
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	787 static OCTARRAY_API Array<T, Alloc>
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	788 cat (int dim, octave_idx_type n, const Array<T, Alloc> *array_list);
10531 2dd8ea8bfd71 basic cat functionality in liboctave Jaroslav Hajek <highegg@gmail.com> parents: 10521 diff changeset	789
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	790 //! Apply function fcn to each element of the Array<T, Alloc>. This function
21567 3d25f9f4a62b maint: Eliminate Britishicisms in the code. Rik <rik@octave.org> parents: 21244 diff changeset	791 //! is optimized with a manually unrolled loop.
30488 abb4823df535 with C++17, match malloc/free for MEX memory (bug #61472) John W. Eaton <jwe@octave.org> parents: 30486 diff changeset	792 #if defined (HAVE_STD_PMR_POLYMORPHIC_ALLOCATOR)
abb4823df535 with C++17, match malloc/free for MEX memory (bug #61472) John W. Eaton <jwe@octave.org> parents: 30486 diff changeset	793 template <typename U, typename F,
abb4823df535 with C++17, match malloc/free for MEX memory (bug #61472) John W. Eaton <jwe@octave.org> parents: 30486 diff changeset	794 typename A = std::pmr::polymorphic_allocator<U>>
abb4823df535 with C++17, match malloc/free for MEX memory (bug #61472) John W. Eaton <jwe@octave.org> parents: 30486 diff changeset	795 #else
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	796 template <typename U, typename F, typename A = std::allocator<U>>
30488 abb4823df535 with C++17, match malloc/free for MEX memory (bug #61472) John W. Eaton <jwe@octave.org> parents: 30486 diff changeset	797 #endif
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	798 Array<U, A>
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	799 map (F fcn) const
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	800 {
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20229 diff changeset	801 octave_idx_type len = numel ();
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	802
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	803 const T *m = data ();
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	804
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	805 Array<U, A> result (dims ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	806 U *p = result.fortran_vec ();
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	807
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	808 octave_idx_type i;
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	809 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	810 {
10312 cbc402e64d83 untabify liboctave header files John W. Eaton <jwe@octave.org> parents: 10158 diff changeset	811 octave_quit ();
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	812
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	813 p[i] = fcn (m[i]);
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	814 p[i+1] = fcn (m[i+1]);
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	815 p[i+2] = fcn (m[i+2]);
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	816 p[i+3] = fcn (m[i+3]);
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	817 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	818
10142 829e69ec3110 make OCTAVE_QUIT a function Jaroslav Hajek <highegg@gmail.com> parents: 10115 diff changeset	819 octave_quit ();
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	820
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	821 for (; i < len; i++)
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	822 p[i] = fcn (m[i]);
f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	823
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	824 return result;
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7463 diff changeset	825 }
8998 a48fba01e4ac optimize isnan/isinf/isfinite mappers Jaroslav Hajek <highegg@gmail.com> parents: 8950 diff changeset	826
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	827 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	828 //! Overloads for function references.
30488 abb4823df535 with C++17, match malloc/free for MEX memory (bug #61472) John W. Eaton <jwe@octave.org> parents: 30486 diff changeset	829 #if defined (HAVE_STD_PMR_POLYMORPHIC_ALLOCATOR)
abb4823df535 with C++17, match malloc/free for MEX memory (bug #61472) John W. Eaton <jwe@octave.org> parents: 30486 diff changeset	830 template <typename U, typename A = std::pmr::polymorphic_allocator<U>>
abb4823df535 with C++17, match malloc/free for MEX memory (bug #61472) John W. Eaton <jwe@octave.org> parents: 30486 diff changeset	831 #else
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	832 template <typename U, typename A = std::allocator<U>>
30488 abb4823df535 with C++17, match malloc/free for MEX memory (bug #61472) John W. Eaton <jwe@octave.org> parents: 30486 diff changeset	833 #endif
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	834 Array<U, A>
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	835 map (U (&fcn) (T)) const
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	836 { return map<U, U (&) (T), A> (fcn); }
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	837
30488 abb4823df535 with C++17, match malloc/free for MEX memory (bug #61472) John W. Eaton <jwe@octave.org> parents: 30486 diff changeset	838 #if defined (HAVE_STD_PMR_POLYMORPHIC_ALLOCATOR)
abb4823df535 with C++17, match malloc/free for MEX memory (bug #61472) John W. Eaton <jwe@octave.org> parents: 30486 diff changeset	839 template <typename U, typename A = std::pmr::polymorphic_allocator<U>>
abb4823df535 with C++17, match malloc/free for MEX memory (bug #61472) John W. Eaton <jwe@octave.org> parents: 30486 diff changeset	840 #else
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	841 template <typename U, typename A = std::allocator<U>>
30488 abb4823df535 with C++17, match malloc/free for MEX memory (bug #61472) John W. Eaton <jwe@octave.org> parents: 30486 diff changeset	842 #endif
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	843 Array<U, A>
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	844 map (U (&fcn) (const T&)) const
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	845 { return map<U, U (&) (const T&), A> (fcn); }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	846 //@}
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9800 diff changeset	847
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	848 //! 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	849 template <typename F, bool zero>
11010 9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	850 bool test (F fcn) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	851 {
29937 da7210e30f3e move some utility functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29931 diff changeset	852 return octave::any_all_test<F, T, zero> (fcn, data (), numel ());
11010 9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	853 }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	854
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	855 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	856 //! Simpler calls.
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	857 template <typename F>
11010 9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	858 bool test_any (F fcn) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	859 { return test<F, false> (fcn); }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	860
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	861 template <typename F>
11010 9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	862 bool test_all (F fcn) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	863 { return test<F, true> (fcn); }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	864 //@}
11010 9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	865
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	866 //@{
96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	867 //! Overloads for function references.
11010 9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	868 bool test_any (bool (&fcn) (T)) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	869 { return test<bool (&) (T), false> (fcn); }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	870
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	871 bool test_any (bool (&fcn) (const T&)) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	872 { return test<bool (&) (const T&), false> (fcn); }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	873
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	874 bool test_all (bool (&fcn) (T)) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	875 { return test<bool (&) (T), true> (fcn); }
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	876
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	877 bool test_all (bool (&fcn) (const T&)) const
9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	878 { return test<bool (&) (const T&), true> (fcn); }
19006 96751a74bbbb Start doxygenising sources Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17769 diff changeset	879 //@}
11010 9478b216752e simplify more array tests Jaroslav Hajek <highegg@gmail.com> parents: 10716 diff changeset	880
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	881 template <typename U, typename A> friend class Array;
9201 472f0e22aa60 guard against implicit instantiation Jaroslav Hajek <highegg@gmail.com> parents: 9046 diff changeset	882
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	883 //! Returns true if this->dims () == dv, and if so, replaces this->m_dimensions
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21660 diff changeset	884 //! 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	885 //! with supposedly equal dimensions (e.g. structs in the interpreter).
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	886 OCTARRAY_API bool optimize_dimensions (const dim_vector& dv);
10674 e3064439d6b4 new Array method for internal use Jaroslav Hajek <highegg@gmail.com> parents: 10673 diff changeset	887
9201 472f0e22aa60 guard against implicit instantiation Jaroslav Hajek <highegg@gmail.com> parents: 9046 diff changeset	888 private:
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	889 OCTARRAY_API static void instantiation_guard ();
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: 4461 diff changeset	890 };
4459 75ee1995d2b4 [project @ 2003-07-11 17:46:41 by jwe] jwe parents: 4192 diff changeset	891
22139 f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	892 // 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	893 // 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	894 // to Container<T>. http://stackoverflow.com/a/20499809/1609556
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	895 template<typename T, typename Alloc>
22139 f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	896 template<template <typename...> class Container>
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	897 Array<T, Alloc>::Array (const Container<T>& a, const dim_vector& dv)
298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	898 : m_dimensions (dv), m_rep (new typename Array<T, Alloc>::ArrayRep (dv.safe_numel ())),
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	899 m_slice_data (m_rep->m_data), m_slice_len (m_rep->m_len)
22139 f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	900 {
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	901 if (m_dimensions.safe_numel () != octave_idx_type (a.size ()))
22139 f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	902 {
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	903 std::string new_dims_str = m_dimensions.str ();
22139 f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	904
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	905 (*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	906 ("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	907 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	908 }
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	909
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	910 octave_idx_type i = 0;
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	911 for (const T& x : a)
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	912 m_slice_data[i++] = x;
22139 f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	913
29887 be669d935fb6 use m_prefix for data members in array classes John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	914 m_dimensions.chop_trailing_singletons ();
22139 f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	915 }
f8212eb6da00 Array: add constructor from std sequence containers (patch 9047) Carnë Draug <carandraug@octave.org> parents: 22022 diff changeset	916
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	917 template <typename T, typename Alloc>
29224 cc4a4df4e32f Add API tag for Array class that is exported from liboctave and liboctinterp (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	918 OCTARRAY_API std::ostream&
30486 298995435071 allow custom allocators for the Array class John W. Eaton <jwe@octave.org> parents: 30429 diff changeset	919 operator << (std::ostream& os, const Array<T, Alloc>& a);
9732 b4fdfee405b5 remove ArrayN<T> + fix nonhom. diag-scalar ops Jaroslav Hajek <highegg@gmail.com> parents: 9731 diff changeset	920
9773 01f897d8a130 optimize memory manipulation by arrays & indexing Jaroslav Hajek <highegg@gmail.com> parents: 9732 diff changeset	921 #endif

Mercurial > octave

annotate liboctave/array/Array.h @ 30488:abb4823df535 stable