octave: liboctave/array/dim-vector.h annotate

annotate liboctave/array/dim-vector.h @ 21509:dcee67d28570

doc: doxygen documentation for dim_vector::ndims and dim_vector::length.

author	Carnë Draug <carandraug@octave.org>
date	Fri, 29 May 2015 00:25:46 +0100
parents	1473547f50f5
children	ae4d7dfea337

rev	line source
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	1 /*
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	2
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19326 diff changeset	3 Copyright (C) 2003-2015 John W. Eaton
10521 4d1fc073fbb7 add some missing copyright stmts Jaroslav Hajek <highegg@gmail.com> parents: 10498 diff changeset	4 Copyirght (C) 2009, 2010 VZLU Prague
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	5
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	6 This file is part of Octave.
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	7
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	8 Octave is free software; you can redistribute it and/or modify it
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	9 under the terms of the GNU General Public License as published by the
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6216 diff changeset	10 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6216 diff changeset	11 option) any later version.
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	12
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	13 Octave is distributed in the hope that it will be useful, but WITHOUT
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	16 for more details.
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	17
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	18 You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6216 diff changeset	19 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6216 diff changeset	20 <http://www.gnu.org/licenses/>.
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	21
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	22 */
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	23
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 20236 diff changeset	24 #if ! defined (octave_dim_vector_h)
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	25 #define octave_dim_vector_h 1
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	26
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21229 diff changeset	27 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21229 diff changeset	28
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	29 #include <cassert>
9840 c0b54271904b improve safe numel() calculation for arrays Jaroslav Hajek <highegg@gmail.com> parents: 9743 diff changeset	30 #include <limits>
8950 d865363208d6 include <iosfwd> instead of <iostream> in header files John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	31
5765 7ba9ad1fec11 [project @ 2006-04-17 05:05:15 by jwe] jwe parents: 5307 diff changeset	32 #include <sstream>
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	33 #include <string>
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	34
6216 74ca56e4414c [project @ 2006-12-22 17:45:47 by jwe] jwe parents: 5765 diff changeset	35 #include "lo-error.h"
10419 afe44ee90cbd implement generic macro magic for repeated decls Jaroslav Hajek <highegg@gmail.com> parents: 10418 diff changeset	36 #include "lo-macros.h"
13985 43cc49c7abd1 Use thread-safe atomic reference counting (GCC and MSVC). Michael Goffioul <michael.goffioul@gmail.com> parents: 11586 diff changeset	37 #include "oct-refcount.h"
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	38
20236 a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	39 //! Vector representing the dimensions (size) of an Array.
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	40 /*!
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	41 A dim_vector is used to represent dimensions of an Array. It is used
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	42 on its constructor to specify its size, or when reshaping it.
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	43
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	44 @code{.cc}
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	45 // Matrix with 10 rows and 20 columns.
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	46 Matrix m Matrix (dim_vector (10, 20));
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	47
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	48 // Change its size to 5 rows and 40 columns.
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	49 Matrix m2 = m.reshape (dim_vector (5, 40));
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	50
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	51 // Five dimensional Array of length 10, 20, 3, 8, 7 on each dimension.
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	52 NDArray a (dim_vector (10, 20, 3, 8, 7));
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	53
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	54 // Uninitialized array of same size as other.
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	55 NDArray b (a.dims ());
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	56 @endcode
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	57
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	58 The main thing to understand about this class, is that methods such as
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	59 ndims() and numel(), return the value for an Array of these dimensions,
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	60 not the actual number of elements in the dim_vector.
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	61
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	62 @code{.cc}
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	63 dim_vector d (10, 5, 3);
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	64 octave_idx_type n = d.numel (); // returns 150
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	65 octave_idx_type nd = d.ndims (); // returns 2
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	66 @endcode
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	67
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	68 ## Implementation details ##
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	69
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	70 This implementation is more tricky than Array, but the big plus is that
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	71 dim_vector requires only one allocation instead of two. It is (slightly)
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	72 patterned after GCC's basic_string implementation. rep is a pointer to an
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	73 array of memory, comprising count, length, and the data:
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	74
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	75 @verbatim
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	76 <count>
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	77 <ndims>
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	78 rep --> <dims[0]>
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	79 <dims[1]>
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	80 ...
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	81 @endverbatim
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	82
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	83 The inlines count(), ndims() recover this data from the rep. Note
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	84 that rep points to the beginning of dims to grant faster access
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	85 (reinterpret_cast is assumed to be an inexpensive operation).
a3bf35bd5b44 doc: doxygen documentation for dim_vector header. Carnë Draug <carandraug@octave.org> parents: 20230 diff changeset	86 */
9507 b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	87
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	88 class
11173 298a75c128ad Additional exported symbols [MSVC] Michael Goffioul <michael.goffioul@gmail.com> parents: 10830 diff changeset	89 OCTAVE_API
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	90 dim_vector
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	91 {
9507 b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	92 private:
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	93
9507 b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	94 octave_idx_type *rep;
4548 820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	95
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	96 octave_idx_type& count (void) const { return rep[-2]; }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	97
19199 3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	98 //! Construct a new rep with count = 1 and ndims given.
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	99
9507 b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	100 static octave_idx_type *newrep (int ndims)
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	101 {
15020 560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code. Rik <rik@octave.org> parents: 14951 diff changeset	102 octave_idx_type *r = new octave_idx_type [ndims + 2];
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	103
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	104 *r++ = 1;
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	105 *r++ = ndims;
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	106
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	107 return r;
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	108 }
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	109
19199 3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	110 //! Clone this->rep.
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	111
9507 b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	112 octave_idx_type *clonerep (void)
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	113 {
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	114 int l = ndims ();
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	115
15020 560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code. Rik <rik@octave.org> parents: 14951 diff changeset	116 octave_idx_type *r = new octave_idx_type [l + 2];
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	117
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	118 *r++ = 1;
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	119 *r++ = l;
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	120
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	121 for (int i = 0; i < l; i++)
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	122 r[i] = rep[i];
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	123
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	124 return r;
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	125 }
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	126
19199 3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	127 //! Clone and resize this->rep to length n, filling by given value.
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	128
9507 b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	129 octave_idx_type *resizerep (int n, octave_idx_type fill_value)
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	130 {
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	131 int l = ndims ();
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	132
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	133 if (n < 2)
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	134 n = 2;
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	135
15020 560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code. Rik <rik@octave.org> parents: 14951 diff changeset	136 octave_idx_type *r = new octave_idx_type [n + 2];
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	137
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	138 *r++ = 1;
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	139 *r++ = n;
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	140
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	141 if (l > n)
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	142 l = n;
4673 6639c2574023 [project @ 2003-12-10 16:11:54 by jwe] jwe parents: 4655 diff changeset	143
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	144 int j;
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	145 for (j = 0; j < l; j++)
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	146 r[j] = rep[j];
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	147 for (; j < n; j++)
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	148 r[j] = fill_value;
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	149
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	150 return r;
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	151 }
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	152
19199 3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	153 //! Free the rep.
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	154
9507 b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	155 void freerep (void)
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	156 {
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	157 assert (count () == 0);
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	158 delete [] (rep - 2);
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	159 }
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	160
4548 820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	161 void make_unique (void)
820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	162 {
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	163 if (count () > 1)
4548 820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	164 {
14445 b50654a09ba7 maint: untabify sources John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	165 octave_idx_type *new_rep = clonerep ();
13985 43cc49c7abd1 Use thread-safe atomic reference counting (GCC and MSVC). Michael Goffioul <michael.goffioul@gmail.com> parents: 11586 diff changeset	166
14445 b50654a09ba7 maint: untabify sources John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	167 if (OCTREFCOUNT_ATOMIC_DECREMENT(&(count())) == 0)
b50654a09ba7 maint: untabify sources John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	168 freerep ();
13985 43cc49c7abd1 Use thread-safe atomic reference counting (GCC and MSVC). Michael Goffioul <michael.goffioul@gmail.com> parents: 11586 diff changeset	169
43cc49c7abd1 Use thread-safe atomic reference counting (GCC and MSVC). Michael Goffioul <michael.goffioul@gmail.com> parents: 11586 diff changeset	170 rep = new_rep;
4548 820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	171 }
820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	172 }
820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	173
820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	174 public:
820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	175
20208 f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	176 // There are constructors for up to 7 dimensions initialized this way.
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	177 // More can be added if necessary.
10419 afe44ee90cbd implement generic macro magic for repeated decls Jaroslav Hajek <highegg@gmail.com> parents: 10418 diff changeset	178 #define ASSIGN_REP(i) rep[i] = d ## i;
afe44ee90cbd implement generic macro magic for repeated decls Jaroslav Hajek <highegg@gmail.com> parents: 10418 diff changeset	179 #define DIM_VECTOR_CTOR(N) \
10420 3373fdc0b14a use macro for 2 and 3 arg dim_vector constructors John W. Eaton <jwe@octave.org> parents: 10419 diff changeset	180 dim_vector (OCT_MAKE_DECL_LIST (octave_idx_type, d, N)) \
10419 afe44ee90cbd implement generic macro magic for repeated decls Jaroslav Hajek <highegg@gmail.com> parents: 10418 diff changeset	181 : rep (newrep (N)) \
afe44ee90cbd implement generic macro magic for repeated decls Jaroslav Hajek <highegg@gmail.com> parents: 10418 diff changeset	182 { \
10420 3373fdc0b14a use macro for 2 and 3 arg dim_vector constructors John W. Eaton <jwe@octave.org> parents: 10419 diff changeset	183 OCT_ITERATE_MACRO (ASSIGN_REP, N) \
10418 6c19d6fcd7e5 up to 7th-order dim_vector constructors Jaroslav Hajek <highegg@gmail.com> parents: 10403 diff changeset	184 }
10419 afe44ee90cbd implement generic macro magic for repeated decls Jaroslav Hajek <highegg@gmail.com> parents: 10418 diff changeset	185
20208 f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	186 //! Construct dim_vector for 2 dimensional array.
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	187 /*!
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	188 It can be used to construct a 2D array. Example:
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	189
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	190 @code{.cc}
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	191 dim_vector dv (7, 5);
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	192 Matrix mat (dv);
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	193 @endcode
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	194
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	195 The constructed dim_vector @c dv will have two elements, @f$[7, 5]@f$,
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	196 one for each dimension. It can then be used to construct a Matrix
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	197 with such dimensions, i.e., 7 rows and 5 columns.
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	198
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	199 There are constructors available for up to 7 dimensions. For a higher
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	200 number of dimensions, use redim() or resize().
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	201
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	202 Note that that there is no constructor for a 1 element dim_vector.
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	203 This is because there are no 1 dimensional Array in liboctave. Such
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	204 constructor did exist in liboctave but was removed in version 4.0.0
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	205 due to its potential for confusion.
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	206 */
10420 3373fdc0b14a use macro for 2 and 3 arg dim_vector constructors John W. Eaton <jwe@octave.org> parents: 10419 diff changeset	207 DIM_VECTOR_CTOR (2)
20208 f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	208
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	209 //! Construct dim_vector for 3 dimensional array.
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	210 /*!
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	211 It can be used to construct a 3D array. Example:
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	212
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	213 @code{.cc}
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	214 NDArray A (dim_vector (7, 5, 4));
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	215 @endcode
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	216
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	217 This will construct a 3 dimensional NDArray of lengths 7, 5, and 4,
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	218 on the first, second, and third dimension (rows, columns, and pages)
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	219 respectively.
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	220 */
10420 3373fdc0b14a use macro for 2 and 3 arg dim_vector constructors John W. Eaton <jwe@octave.org> parents: 10419 diff changeset	221 DIM_VECTOR_CTOR (3)
20208 f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	222
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	223 //! Construct dim_vector for 4 dimensional array.
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	224 //! @see dim_vector(octave_idx_type d0, octave_idx_type d1)
10420 3373fdc0b14a use macro for 2 and 3 arg dim_vector constructors John W. Eaton <jwe@octave.org> parents: 10419 diff changeset	225 DIM_VECTOR_CTOR (4)
20208 f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	226 //! Construct dim_vector for 5 dimensional array.
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	227 //! @see dim_vector(octave_idx_type d0, octave_idx_type d1)
10420 3373fdc0b14a use macro for 2 and 3 arg dim_vector constructors John W. Eaton <jwe@octave.org> parents: 10419 diff changeset	228 DIM_VECTOR_CTOR (5)
20208 f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	229 //! Construct dim_vector for 6 dimensional array.
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	230 //! @see dim_vector(octave_idx_type d0, octave_idx_type d1)
10420 3373fdc0b14a use macro for 2 and 3 arg dim_vector constructors John W. Eaton <jwe@octave.org> parents: 10419 diff changeset	231 DIM_VECTOR_CTOR (6)
20208 f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	232 //! Construct dim_vector for 7 dimensional array.
f638a61af5a8 doxygen: improve dim_vector constructor documentation (bug #45105) Piotr Held <pjheld@gmail.com> parents: 19861 diff changeset	233 //! @see dim_vector(octave_idx_type d0, octave_idx_type d1)
10420 3373fdc0b14a use macro for 2 and 3 arg dim_vector constructors John W. Eaton <jwe@octave.org> parents: 10419 diff changeset	234 DIM_VECTOR_CTOR (7)
10419 afe44ee90cbd implement generic macro magic for repeated decls Jaroslav Hajek <highegg@gmail.com> parents: 10418 diff changeset	235
afe44ee90cbd implement generic macro magic for repeated decls Jaroslav Hajek <highegg@gmail.com> parents: 10418 diff changeset	236 #undef ASSIGN_REP
afe44ee90cbd implement generic macro magic for repeated decls Jaroslav Hajek <highegg@gmail.com> parents: 10418 diff changeset	237 #undef DIM_VECTOR_CTOR
afe44ee90cbd implement generic macro magic for repeated decls Jaroslav Hajek <highegg@gmail.com> parents: 10418 diff changeset	238
9507 b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	239 octave_idx_type& elem (int i)
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	240 {
21229 a83e7a384ee0 create and install a subset of config.h in octave-config.h John W. Eaton <jwe@octave.org> parents: 21131 diff changeset	241 #ifdef OCTAVE_ENABLE_BOUNDS_CHECK
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	242 assert (i >= 0 && i < ndims ());
10366 e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10350 diff changeset	243 #endif
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	244 make_unique ();
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	245 return rep[i];
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	246 }
9507 b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	247
b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	248 octave_idx_type elem (int i) const
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	249 {
21229 a83e7a384ee0 create and install a subset of config.h in octave-config.h John W. Eaton <jwe@octave.org> parents: 21131 diff changeset	250 #ifdef OCTAVE_ENABLE_BOUNDS_CHECK
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	251 assert (i >= 0 && i < ndims ());
10366 e5ae13b8b2c2 improve Array indexing error messages Jaroslav Hajek <highegg@gmail.com> parents: 10350 diff changeset	252 #endif
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	253 return rep[i];
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	254 }
9507 b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	255
b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	256 void chop_trailing_singletons (void)
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	257 {
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	258 int l = ndims ();
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	259 if (l > 2 && rep[l-1] == 1)
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	260 {
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	261 make_unique ();
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	262 do
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	263 l--;
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	264 while (l > 2 && rep[l-1] == 1);
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	265 ndims () = l;
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	266 }
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	267 }
9507 b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	268
10681 0ba9bd294421 make cat() (hopefully) more matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10645 diff changeset	269 void chop_all_singletons (void);
9507 b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	270
14951 4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14625 diff changeset	271 // WARNING: Only call by jit
4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14625 diff changeset	272 octave_idx_type *to_jit (void) const
4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14625 diff changeset	273 {
4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14625 diff changeset	274 return rep;
4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14625 diff changeset	275 }
4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14625 diff changeset	276
9507 b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	277 private:
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	278
9507 b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	279 static octave_idx_type *nil_rep (void)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	280 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	281 static dim_vector zv (0, 0);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	282 return zv.rep;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	283 }
9507 b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	284
b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	285 public:
b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	286
10830 b4ebfd675321 avoid static initialization disaster in dim_vector Jaroslav Hajek <highegg@gmail.com> parents: 10810 diff changeset	287 static octave_idx_type dim_max (void);
10810 6683f0c9d742 make the maximum extent externally accessible Jaroslav Hajek <highegg@gmail.com> parents: 10715 diff changeset	288
13985 43cc49c7abd1 Use thread-safe atomic reference counting (GCC and MSVC). Michael Goffioul <michael.goffioul@gmail.com> parents: 11586 diff changeset	289 explicit dim_vector (void) : rep (nil_rep ())
43cc49c7abd1 Use thread-safe atomic reference counting (GCC and MSVC). Michael Goffioul <michael.goffioul@gmail.com> parents: 11586 diff changeset	290 { OCTREFCOUNT_ATOMIC_INCREMENT (&(count())); }
4548 820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	291
13985 43cc49c7abd1 Use thread-safe atomic reference counting (GCC and MSVC). Michael Goffioul <michael.goffioul@gmail.com> parents: 11586 diff changeset	292 dim_vector (const dim_vector& dv) : rep (dv.rep)
43cc49c7abd1 Use thread-safe atomic reference counting (GCC and MSVC). Michael Goffioul <michael.goffioul@gmail.com> parents: 11586 diff changeset	293 { OCTREFCOUNT_ATOMIC_INCREMENT (&(count())); }
9507 b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	294
14951 4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14625 diff changeset	295 // FIXME: Should be private, but required by array constructor for jit
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	296 explicit dim_vector (octave_idx_type *r) : rep (r) { }
14951 4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14625 diff changeset	297
9507 b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	298 static dim_vector alloc (int n)
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	299 {
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	300 return dim_vector (newrep (n < 2 ? 2 : n));
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	301 }
4548 820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	302
820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	303 dim_vector& operator = (const dim_vector& dv)
820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	304 {
820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	305 if (&dv != this)
820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	306 {
13985 43cc49c7abd1 Use thread-safe atomic reference counting (GCC and MSVC). Michael Goffioul <michael.goffioul@gmail.com> parents: 11586 diff changeset	307 if (OCTREFCOUNT_ATOMIC_DECREMENT (&(count())) == 0)
9507 b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	308 freerep ();
4548 820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	309
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	310 rep = dv.rep;
13985 43cc49c7abd1 Use thread-safe atomic reference counting (GCC and MSVC). Michael Goffioul <michael.goffioul@gmail.com> parents: 11586 diff changeset	311 OCTREFCOUNT_ATOMIC_INCREMENT (&(count()));
4548 820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	312 }
820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	313
820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	314 return *this;
820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	315 }
820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	316
820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	317 ~dim_vector (void)
820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	318 {
13985 43cc49c7abd1 Use thread-safe atomic reference counting (GCC and MSVC). Michael Goffioul <michael.goffioul@gmail.com> parents: 11586 diff changeset	319 if (OCTREFCOUNT_ATOMIC_DECREMENT (&(count())) == 0)
9507 b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	320 freerep ();
4548 820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	321 }
820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	322
21509 dcee67d28570 doc: doxygen documentation for dim_vector::ndims and dim_vector::length. Carnë Draug <carandraug@octave.org> parents: 21244 diff changeset	323 //! Number of dimensions.
dcee67d28570 doc: doxygen documentation for dim_vector::ndims and dim_vector::length. Carnë Draug <carandraug@octave.org> parents: 21244 diff changeset	324 /*!
dcee67d28570 doc: doxygen documentation for dim_vector::ndims and dim_vector::length. Carnë Draug <carandraug@octave.org> parents: 21244 diff changeset	325 Returns the number of dimensions of the dim_vector. This is number of
dcee67d28570 doc: doxygen documentation for dim_vector::ndims and dim_vector::length. Carnë Draug <carandraug@octave.org> parents: 21244 diff changeset	326 elements in the dim_vector including trailing singetons. It is also
dcee67d28570 doc: doxygen documentation for dim_vector::ndims and dim_vector::length. Carnë Draug <carandraug@octave.org> parents: 21244 diff changeset	327 the number of dimensions an Array with this dim_vector would have.
dcee67d28570 doc: doxygen documentation for dim_vector::ndims and dim_vector::length. Carnë Draug <carandraug@octave.org> parents: 21244 diff changeset	328 */
dcee67d28570 doc: doxygen documentation for dim_vector::ndims and dim_vector::length. Carnë Draug <carandraug@octave.org> parents: 21244 diff changeset	329 octave_idx_type& ndims (void) const { return rep[-1]; }
dcee67d28570 doc: doxygen documentation for dim_vector::ndims and dim_vector::length. Carnë Draug <carandraug@octave.org> parents: 21244 diff changeset	330
dcee67d28570 doc: doxygen documentation for dim_vector::ndims and dim_vector::length. Carnë Draug <carandraug@octave.org> parents: 21244 diff changeset	331 //! Number of dimensions.
dcee67d28570 doc: doxygen documentation for dim_vector::ndims and dim_vector::length. Carnë Draug <carandraug@octave.org> parents: 21244 diff changeset	332 //! Synonymous with ndims().
dcee67d28570 doc: doxygen documentation for dim_vector::ndims and dim_vector::length. Carnë Draug <carandraug@octave.org> parents: 21244 diff changeset	333 /*!
dcee67d28570 doc: doxygen documentation for dim_vector::ndims and dim_vector::length. Carnë Draug <carandraug@octave.org> parents: 21244 diff changeset	334 While this method is not officially deprecated, consider using ndims()
dcee67d28570 doc: doxygen documentation for dim_vector::ndims and dim_vector::length. Carnë Draug <carandraug@octave.org> parents: 21244 diff changeset	335 instead to avoid confusion. Array does not have length because of its
dcee67d28570 doc: doxygen documentation for dim_vector::ndims and dim_vector::length. Carnë Draug <carandraug@octave.org> parents: 21244 diff changeset	336 odd definition as length of the longest dimension.
dcee67d28570 doc: doxygen documentation for dim_vector::ndims and dim_vector::length. Carnë Draug <carandraug@octave.org> parents: 21244 diff changeset	337 */
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	338 int length (void) const { return ndims (); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	339
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	340 octave_idx_type& operator () (int i) { return elem (i); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	341
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	342 octave_idx_type operator () (int i) const { return elem (i); }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	343
4887 bbddd4339cf2 [project @ 2004-04-30 17:08:55 by jwe] jwe parents: 4735 diff changeset	344 void resize (int n, int fill_value = 0)
4548 820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	345 {
820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	346 int len = length ();
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	347
4548 820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	348 if (n != len)
820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	349 {
9507 b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	350 octave_idx_type *r = resizerep (n, fill_value);
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	351
13985 43cc49c7abd1 Use thread-safe atomic reference counting (GCC and MSVC). Michael Goffioul <michael.goffioul@gmail.com> parents: 11586 diff changeset	352 if (OCTREFCOUNT_ATOMIC_DECREMENT (&(count())) == 0)
9507 b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	353 freerep ();
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	354
9507 b096d11237be dim_vector improvements Jaroslav Hajek <highegg@gmail.com> parents: 9420 diff changeset	355 rep = r;
4548 820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	356 }
820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	357 }
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	358
10681 0ba9bd294421 make cat() (hopefully) more matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10645 diff changeset	359 std::string str (char sep = 'x') const;
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	360
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	361 bool all_zero (void) const
4548 820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	362 {
820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	363 bool retval = true;
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	364
4548 820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	365 for (int i = 0; i < length (); i++)
820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	366 {
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	367 if (elem (i) != 0)
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	368 {
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	369 retval = false;
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	370 break;
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	371 }
4548 820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	372 }
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	373
4548 820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	374 return retval;
820323598f4f [project @ 2003-10-26 03:16:42 by jwe] jwe parents: 4543 diff changeset	375 }
4559 802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4548 diff changeset	376
10715 53253f796351 make [] (hopefully) more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10681 diff changeset	377 bool empty_2d (void) const
53253f796351 make [] (hopefully) more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10681 diff changeset	378 {
53253f796351 make [] (hopefully) more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10681 diff changeset	379 return length () == 2 && (elem (0) == 0 \|\| elem (1) == 0);
53253f796351 make [] (hopefully) more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10681 diff changeset	380 }
53253f796351 make [] (hopefully) more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10681 diff changeset	381
53253f796351 make [] (hopefully) more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10681 diff changeset	382
9886 cddd5c3d5f04 fix & extend special-case optimizations for indexed assignment Jaroslav Hajek <highegg@gmail.com> parents: 9840 diff changeset	383 bool zero_by_zero (void) const
cddd5c3d5f04 fix & extend special-case optimizations for indexed assignment Jaroslav Hajek <highegg@gmail.com> parents: 9840 diff changeset	384 {
cddd5c3d5f04 fix & extend special-case optimizations for indexed assignment Jaroslav Hajek <highegg@gmail.com> parents: 9840 diff changeset	385 return length () == 2 && elem (0) == 0 && elem (1) == 0;
cddd5c3d5f04 fix & extend special-case optimizations for indexed assignment Jaroslav Hajek <highegg@gmail.com> parents: 9840 diff changeset	386 }
cddd5c3d5f04 fix & extend special-case optimizations for indexed assignment Jaroslav Hajek <highegg@gmail.com> parents: 9840 diff changeset	387
4559 802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4548 diff changeset	388 bool any_zero (void) const
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4548 diff changeset	389 {
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4548 diff changeset	390 bool retval = false;
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4548 diff changeset	391
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4548 diff changeset	392 for (int i = 0; i < length (); i++)
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4548 diff changeset	393 {
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	394 if (elem (i) == 0)
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	395 {
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	396 retval = true;
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	397 break;
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	398 }
4559 802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4548 diff changeset	399 }
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4548 diff changeset	400
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4548 diff changeset	401 return retval;
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe] jwe parents: 4548 diff changeset	402 }
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	403
10681 0ba9bd294421 make cat() (hopefully) more matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10645 diff changeset	404 int num_ones (void) const;
4635 f2cd320cbf6e [project @ 2003-11-20 01:48:23 by jwe] jwe parents: 4567 diff changeset	405
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	406 bool all_ones (void) const
4655 c8829691db47 [project @ 2003-11-24 21:24:37 by jwe] jwe parents: 4635 diff changeset	407 {
c8829691db47 [project @ 2003-11-24 21:24:37 by jwe] jwe parents: 4635 diff changeset	408 return (num_ones () == length ());
c8829691db47 [project @ 2003-11-24 21:24:37 by jwe] jwe parents: 4635 diff changeset	409 }
c8829691db47 [project @ 2003-11-24 21:24:37 by jwe] jwe parents: 4635 diff changeset	410
19199 3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	411 //! Number of elements that a matrix with this dimensions would have.
19861 19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	412 /*!
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	413 Return the number of elements that a matrix with this dimension
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	414 vector would have, NOT the number of dimensions (elements in the
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	415 dimension vector).
19199 3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	416 */
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	417
9027 9a46ba093db4 generalize dim_vector::numel Jaroslav Hajek <highegg@gmail.com> parents: 8950 diff changeset	418 octave_idx_type numel (int n = 0) const
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	419 {
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	420 int n_dims = length ();
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	421
9027 9a46ba093db4 generalize dim_vector::numel Jaroslav Hajek <highegg@gmail.com> parents: 8950 diff changeset	422 octave_idx_type retval = 1;
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	423
9027 9a46ba093db4 generalize dim_vector::numel Jaroslav Hajek <highegg@gmail.com> parents: 8950 diff changeset	424 for (int i = n; i < n_dims; i++)
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	425 retval *= elem (i);
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	426
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	427 return retval;
fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4565 diff changeset	428 }
4673 6639c2574023 [project @ 2003-12-10 16:11:54 by jwe] jwe parents: 4655 diff changeset	429
19861 19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	430 /*!
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	431 The following function will throw a std::bad_alloc ()
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	432 exception if the requested size is larger than can be indexed by
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	433 octave_idx_type. This may be smaller than the actual amount of
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	434 memory that can be safely allocated on a system. However, if we
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	435 don't fail here, we can end up with a mysterious crash inside a
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	436 function that is iterating over an array using octave_idx_type
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	437 indices.
19199 3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	438 */
9840 c0b54271904b improve safe numel() calculation for arrays Jaroslav Hajek <highegg@gmail.com> parents: 9743 diff changeset	439
10681 0ba9bd294421 make cat() (hopefully) more matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10645 diff changeset	440 octave_idx_type safe_numel (void) const;
9840 c0b54271904b improve safe numel() calculation for arrays Jaroslav Hajek <highegg@gmail.com> parents: 9743 diff changeset	441
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	442 bool any_neg (void) const
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	443 {
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	444 int n_dims = length ();
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	445 int i;
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	446
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	447 for (i = 0; i < n_dims; i++)
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	448 if (elem (i) < 0)
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	449 break;
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	450
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	451 return i < n_dims;
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	452 }
7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	453
10681 0ba9bd294421 make cat() (hopefully) more matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10645 diff changeset	454 dim_vector squeeze (void) const;
10498 8615b55b5caf fix & improve cat (bug #29465) Jaroslav Hajek <highegg@gmail.com> parents: 10420 diff changeset	455
19199 3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	456 //! This corresponds to cat().
10715 53253f796351 make [] (hopefully) more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10681 diff changeset	457 bool concat (const dim_vector& dvb, int dim);
53253f796351 make [] (hopefully) more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10681 diff changeset	458
19199 3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	459 //! This corresponds to [,] (horzcat, dim = 0) and [;] (vertcat, dim = 1).
10715 53253f796351 make [] (hopefully) more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10681 diff changeset	460 // The rules are more relaxed here.
53253f796351 make [] (hopefully) more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10681 diff changeset	461 bool hvcat (const dim_vector& dvb, int dim);
8290 7cbe01c21986 improve dense array indexing Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	462
19199 3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	463 /*!
3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	464 Force certain dimensionality, preserving numel (). Missing
3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	465 dimensions are set to 1, redundant are folded into the trailing
3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	466 one. If n = 1, the result is 2d and the second dim is 1
3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	467 (dim_vectors are always at least 2D).
3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	468 */
10681 0ba9bd294421 make cat() (hopefully) more matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10645 diff changeset	469 dim_vector redim (int n) const;
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8290 diff changeset	470
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10150 diff changeset	471 dim_vector as_column (void) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	472 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	473 if (length () == 2 && elem (1) == 1)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	474 return *this;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	475 else
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	476 return dim_vector (numel (), 1);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	477 }
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10150 diff changeset	478
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10150 diff changeset	479 dim_vector as_row (void) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	480 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	481 if (length () == 2 && elem (0) == 1)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	482 return *this;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	483 else
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	484 return dim_vector (1, numel ());
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	485 }
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10150 diff changeset	486
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8290 diff changeset	487 bool is_vector (void) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	488 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	489 return (length () == 2 && (elem (0) == 1 \|\| elem (1) == 1));
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	490 }
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8290 diff changeset	491
9511 cc1fd3084cb2 implement dim_vector::first_non_singleton Jaroslav Hajek <highegg@gmail.com> parents: 9507 diff changeset	492 int first_non_singleton (int def = 0) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	493 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	494 for (int i = 0; i < length (); i++)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	495 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	496 if (elem (i) != 1)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	497 return i;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	498 }
9511 cc1fd3084cb2 implement dim_vector::first_non_singleton Jaroslav Hajek <highegg@gmail.com> parents: 9507 diff changeset	499
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	500 return def;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	501 }
9511 cc1fd3084cb2 implement dim_vector::first_non_singleton Jaroslav Hajek <highegg@gmail.com> parents: 9507 diff changeset	502
19199 3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	503 //! Compute a linear index from an index tuple.
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	504
10645 8645b7087859 abstract scalar index checking off Array<T> (prep for struct optimizations) Jaroslav Hajek <highegg@gmail.com> parents: 10586 diff changeset	505 octave_idx_type compute_index (const octave_idx_type *idx) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	506 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	507 octave_idx_type k = 0;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	508 for (int i = length () - 1; i >= 0; i--)
20230 e914b5399c67 Use in-place operators in C++ code where possible. Rik <rik@octave.org> parents: 20208 diff changeset	509 k = rep[i] * k + idx[i];
9739 13b57eec9440 a few handy methods for dim_vector Jaroslav Hajek <highegg@gmail.com> parents: 9694 diff changeset	510
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	511 return k;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	512 }
9739 13b57eec9440 a few handy methods for dim_vector Jaroslav Hajek <highegg@gmail.com> parents: 9694 diff changeset	513
19199 3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	514 //! Ditto, but the tuple may be incomplete (nidx < length ()).
10645 8645b7087859 abstract scalar index checking off Array<T> (prep for struct optimizations) Jaroslav Hajek <highegg@gmail.com> parents: 10586 diff changeset	515
8645b7087859 abstract scalar index checking off Array<T> (prep for struct optimizations) Jaroslav Hajek <highegg@gmail.com> parents: 10586 diff changeset	516 octave_idx_type compute_index (const octave_idx_type *idx, int nidx) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	517 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	518 octave_idx_type k = 0;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	519 for (int i = nidx - 1; i >= 0; i--)
20230 e914b5399c67 Use in-place operators in C++ code where possible. Rik <rik@octave.org> parents: 20208 diff changeset	520 k = rep[i] * k + idx[i];
10645 8645b7087859 abstract scalar index checking off Array<T> (prep for struct optimizations) Jaroslav Hajek <highegg@gmail.com> parents: 10586 diff changeset	521
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	522 return k;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	523 }
10645 8645b7087859 abstract scalar index checking off Array<T> (prep for struct optimizations) Jaroslav Hajek <highegg@gmail.com> parents: 10586 diff changeset	524
19199 3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	525 /*/!
3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	526 Increment a multi-dimensional index tuple, optionally starting
3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	527 from an offset position and return the index of the last index
3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	528 position that was changed, or length () if just cycled over.
3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	529 */
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	530
10645 8645b7087859 abstract scalar index checking off Array<T> (prep for struct optimizations) Jaroslav Hajek <highegg@gmail.com> parents: 10586 diff changeset	531 int increment_index (octave_idx_type *idx, int start = 0) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	532 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	533 int i;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	534 for (i = start; i < length (); i++)
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 if (++(*idx) == rep[i])
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	537 *idx++ = 0;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	538 else
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	539 break;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	540 }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	541 return i;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	542 }
9739 13b57eec9440 a few handy methods for dim_vector Jaroslav Hajek <highegg@gmail.com> parents: 9694 diff changeset	543
19199 3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	544 //! Return cumulative dimensions.
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	545
9739 13b57eec9440 a few handy methods for dim_vector Jaroslav Hajek <highegg@gmail.com> parents: 9694 diff changeset	546 dim_vector cumulative (void) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	547 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	548 int nd = length ();
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	549 dim_vector retval = alloc (nd);
9739 13b57eec9440 a few handy methods for dim_vector Jaroslav Hajek <highegg@gmail.com> parents: 9694 diff changeset	550
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	551 octave_idx_type k = 1;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	552 for (int i = 0; i < nd; i++)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	553 retval.rep[i] = k *= rep[i];
9739 13b57eec9440 a few handy methods for dim_vector Jaroslav Hajek <highegg@gmail.com> parents: 9694 diff changeset	554
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	555 return retval;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	556 }
9739 13b57eec9440 a few handy methods for dim_vector Jaroslav Hajek <highegg@gmail.com> parents: 9694 diff changeset	557
19199 3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	558 //! Compute a linear index from an index tuple. Dimensions are
3a6fd52e1458 liboctave/array/dim-vector.h: convert comments to doxygen Carnë Draug <carandraug@octave.org> parents: 17769 diff changeset	559 //! required to be cumulative.
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	560
10645 8645b7087859 abstract scalar index checking off Array<T> (prep for struct optimizations) Jaroslav Hajek <highegg@gmail.com> parents: 10586 diff changeset	561 octave_idx_type cum_compute_index (const octave_idx_type *idx) const
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	562 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	563 octave_idx_type k = idx[0];
9739 13b57eec9440 a few handy methods for dim_vector Jaroslav Hajek <highegg@gmail.com> parents: 9694 diff changeset	564
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	565 for (int i = 1; i < length (); i++)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	566 k += rep[i-1] * idx[i];
9739 13b57eec9440 a few handy methods for dim_vector Jaroslav Hajek <highegg@gmail.com> parents: 9694 diff changeset	567
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	568 return k;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	569 }
9739 13b57eec9440 a few handy methods for dim_vector Jaroslav Hajek <highegg@gmail.com> parents: 9694 diff changeset	570
13b57eec9440 a few handy methods for dim_vector Jaroslav Hajek <highegg@gmail.com> parents: 9694 diff changeset	571
9694 50db3c5175b5 allow unpacked form of LU Jaroslav Hajek <highegg@gmail.com> parents: 9666 diff changeset	572 friend bool operator == (const dim_vector& a, const dim_vector& b);
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	573 };
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	574
9694 50db3c5175b5 allow unpacked form of LU Jaroslav Hajek <highegg@gmail.com> parents: 9666 diff changeset	575 inline bool
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	576 operator == (const dim_vector& a, const dim_vector& b)
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	577 {
9694 50db3c5175b5 allow unpacked form of LU Jaroslav Hajek <highegg@gmail.com> parents: 9666 diff changeset	578 // Fast case.
50db3c5175b5 allow unpacked form of LU Jaroslav Hajek <highegg@gmail.com> parents: 9666 diff changeset	579 if (a.rep == b.rep)
50db3c5175b5 allow unpacked form of LU Jaroslav Hajek <highegg@gmail.com> parents: 9666 diff changeset	580 return true;
50db3c5175b5 allow unpacked form of LU Jaroslav Hajek <highegg@gmail.com> parents: 9666 diff changeset	581
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	582 bool retval = true;
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	583
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	584 int a_len = a.length ();
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	585 int b_len = b.length ();
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	586
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	587 if (a_len != b_len)
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	588 retval = false;
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	589 else
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	590 {
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	591 for (int i = 0; i < a_len; i++)
10150 3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	592 {
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	593 if (a(i) != b(i))
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	594 {
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	595 retval = false;
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	596 break;
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	597 }
3778ea95adea style fixes John W. Eaton <jwe@octave.org> parents: 10095 diff changeset	598 }
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	599 }
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	600
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	601 return retval;
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	602 }
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	603
9694 50db3c5175b5 allow unpacked form of LU Jaroslav Hajek <highegg@gmail.com> parents: 9666 diff changeset	604 inline bool
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	605 operator != (const dim_vector& a, const dim_vector& b)
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	606 {
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	607 return ! operator == (a, b);
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	608 }
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4532 diff changeset	609
4513 508238e65af7 [project @ 2003-09-19 21:40:57 by jwe] jwe parents: diff changeset	610 #endif

Mercurial > octave

annotate liboctave/array/dim-vector.h @ 21509:dcee67d28570