octave-lyh: liboctave/MArray.h annotate

annotate liboctave/MArray.h @ 14193:72aebe619641 stable rc-3-6-0-0

3.6.0-rc0 release candidate * configure.ac (AC_INIT): Version is now 3.6.0-rc0. (OCTAVE_RELEASE_DATE): Now 2012-01-10. (OCTAVE_API_VERSION_NUMBER): Now 47.

author	John W. Eaton <jwe@octave.org>
date	Tue, 10 Jan 2012 16:43:41 -0500
parents	72c96de7a403
children	4c9fd3e31436

rev	line source
1993 1b57120c997b [project @ 1996-03-03 01:16:15 by jwe] jwe parents: 1992 diff changeset	1 // Template array classes with like-type math ops
237 5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	2 /*
5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	3
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 11586 diff changeset	4 Copyright (C) 1993-2012 John W. Eaton
10521 4d1fc073fbb7 add some missing copyright stmts Jaroslav Hajek <highegg@gmail.com> parents: 10396 diff changeset	5 Copyright (C) 2010 VZLU Prague
237 5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	6
5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	7 This file is part of Octave.
5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	8
5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	9 Octave is free software; you can redistribute it and/or modify it
5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	10 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: 6708 diff changeset	11 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6708 diff changeset	12 option) any later version.
237 5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	13
5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	14 Octave is distributed in the hope that it will be useful, but WITHOUT
5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	15 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	16 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	17 for more details.
5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	18
5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	19 You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6708 diff changeset	20 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6708 diff changeset	21 <http://www.gnu.org/licenses/>.
237 5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	22
5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	23 */
5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	24
382 e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe] jwe parents: 237 diff changeset	25 #if !defined (octave_MArray_h)
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe] jwe parents: 237 diff changeset	26 #define octave_MArray_h 1
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe] jwe parents: 237 diff changeset	27
237 5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	28 #include "Array.h"
5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	29
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	30 // N-dimensional array with math ops.
3107 a8dcfbf87ea3 [project @ 1997-11-19 22:34:59 by jwe] jwe parents: 2847 diff changeset	31
3573 6ae6f1180e62 [project @ 2000-02-04 09:01:59 by jwe] jwe parents: 3504 diff changeset	32 // But first, some preprocessor abuse...
3107 a8dcfbf87ea3 [project @ 1997-11-19 22:34:59 by jwe] jwe parents: 2847 diff changeset	33
8774 b756ce0002db split implementation and interface in mx-op-defs and MArray-defs Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	34 #include "MArray-decl.h"
3107 a8dcfbf87ea3 [project @ 1997-11-19 22:34:59 by jwe] jwe parents: 2847 diff changeset	35
6708 0ce71beb1cf3 [project @ 2007-06-13 06:40:48 by jwe] jwe parents: 6508 diff changeset	36 MARRAY_OPS_FORWARD_DECLS (MArray, )
237 5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	37
5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	38 template <class T>
3585 d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3573 diff changeset	39 class
d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3573 diff changeset	40 MArray : public Array<T>
237 5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	41 {
5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	42 public:
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	43
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	44 MArray (void) : Array<T> () {}
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	45
11570 57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	46 explicit MArray (octave_idx_type n) GCC_ATTR_DEPRECATED
57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	47 : Array<T> (dim_vector (n, 1)) { }
3585 d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3573 diff changeset	48
11570 57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	49 MArray (octave_idx_type n, const T& val) GCC_ATTR_DEPRECATED
57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	50 : Array<T> (dim_vector (n, 1), val) { }
3585 d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3573 diff changeset	51
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	52 explicit MArray (const dim_vector& dv)
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	53 : Array<T> (dv) { }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	54
12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	55 explicit MArray (const dim_vector& dv, const T& val)
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	56 : Array<T> (dv, val) { }
3585 d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3573 diff changeset	57
d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3573 diff changeset	58 MArray (const MArray<T>& a) : Array<T> (a) { }
d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3573 diff changeset	59
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	60 template <class U>
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	61 MArray (const Array<U>& a) : Array<T> (a) { }
237 5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	62
1230 92609e161b29 [project @ 1995-04-10 01:08:57 by jwe] jwe parents: 1213 diff changeset	63 ~MArray (void) { }
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe] jwe parents: 1213 diff changeset	64
237 5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	65 MArray<T>& operator = (const MArray<T>& a)
1213 9689615b34f2 [project @ 1995-04-06 02:25:15 by jwe] jwe parents: 1011 diff changeset	66 {
9689615b34f2 [project @ 1995-04-06 02:25:15 by jwe] jwe parents: 1011 diff changeset	67 Array<T>::operator = (a);
9689615b34f2 [project @ 1995-04-06 02:25:15 by jwe] jwe parents: 1011 diff changeset	68 return *this;
9689615b34f2 [project @ 1995-04-06 02:25:15 by jwe] jwe parents: 1011 diff changeset	69 }
3573 6ae6f1180e62 [project @ 2000-02-04 09:01:59 by jwe] jwe parents: 3504 diff changeset	70
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	71 MArray<T> reshape (const dim_vector& new_dims) const
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	72 { return Array<T>::reshape (new_dims); }
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	73
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	74 MArray<T> permute (const Array<octave_idx_type>& vec,
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	75 bool inv = false) const
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	76 { return Array<T>::permute (vec, inv); }
9612 66970dd627f6 further liboctave design improvements Jaroslav Hajek <highegg@gmail.com> parents: 8934 diff changeset	77
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	78 MArray<T> ipermute (const Array<octave_idx_type>& vec) const
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	79 { return Array<T>::ipermute (vec); }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7503 diff changeset	80
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	81 MArray squeeze (void) const { return Array<T>::squeeze (); }
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	82
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	83 MArray<T> transpose (void) const
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	84 { return Array<T>::transpose (); }
5602 dfa2da0563e5 [project @ 2006-01-31 03:43:40 by jwe] jwe parents: 5307 diff changeset	85
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	86 MArray<T> hermitian (T (*fcn) (const T&) = 0) const
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	87 { return Array<T>::hermitian (fcn); }
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	88
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	89 // Performs indexed accumulative addition.
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	90
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	91 void idx_add (const idx_vector& idx, T val);
9812 f80c566bc751 improve unary mapper system Jaroslav Hajek <highegg@gmail.com> parents: 9612 diff changeset	92
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	93 void idx_add (const idx_vector& idx, const MArray<T>& vals);
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	94
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	95 void idx_min (const idx_vector& idx, const MArray<T>& vals);
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7017 diff changeset	96
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	97 void idx_max (const idx_vector& idx, const MArray<T>& vals);
3573 6ae6f1180e62 [project @ 2000-02-04 09:01:59 by jwe] jwe parents: 3504 diff changeset	98
10396 a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	99 void idx_add_nd (const idx_vector& idx, const MArray<T>& vals, int dim = -1);
a0b51ac0f88a optimize accumdim with summation Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	100
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	101 void changesign (void);
237 5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	102 };
5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	103
5a9e23307fb0 [project @ 1993-11-30 20:23:04 by jwe] jwe parents: diff changeset	104 #endif

Mercurial > hg > octave-lyh

annotate liboctave/MArray.h @ 14193:72aebe619641 stable rc-3-6-0-0