octave: liboctave/array/dColVector.h annotate

annotate liboctave/array/dColVector.h @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.

author	John W. Eaton <jwe@octave.org>
date	Mon, 06 Jan 2020 22:29:51 -0500
parents	b442ec6dda5c
children	bd51beb6205e

rev	line source
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	1 /*
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	2
27919 1891570abac8 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27918 diff changeset	3 Copyright (C) 1994-2020 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	4
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	5 See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	6 or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	7
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	8
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	9 This file is part of Octave.
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	10
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23443 diff changeset	11 Octave is free software: you can redistribute it and/or modify it
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	12 under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23443 diff changeset	13 the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	14 (at your option) any later version.
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	15
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	16 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	17 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	19 GNU General Public License for more details.
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	20
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	21 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: 6108 diff changeset	22 along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23443 diff changeset	23 <https://www.gnu.org/licenses/>.
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	24
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	25 */
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	26
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 19697 diff changeset	27 #if ! defined (octave_dColVector_h)
17822 ebb3ef964372 maint: Use common #define syntax "octave_filename_h" in h_files. Rik <rik@octave.org> parents: 17769 diff changeset	28 #define octave_dColVector_h 1
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	29
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	30 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	31
1214 0bf4d2b7def4 [project @ 1995-04-06 02:33:59 by jwe] jwe parents: 1205 diff changeset	32 #include "MArray.h"
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	33 #include "mx-defs.h"
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	34
3585 d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3580 diff changeset	35 class
6108 143b556ce725 [project @ 2006-10-27 01:45:54 by jwe] jwe parents: 5508 diff changeset	36 OCTAVE_API
3585 d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3580 diff changeset	37 ColumnVector : public MArray<double>
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	38 {
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	39 public:
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	40
11570 57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	41 ColumnVector (void) : MArray<double> (dim_vector (0, 1)) { }
3585 d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3580 diff changeset	42
11570 57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	43 explicit ColumnVector (octave_idx_type n)
57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	44 : MArray<double> (dim_vector (n, 1)) { }
3585 d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3580 diff changeset	45
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	46 explicit ColumnVector (const dim_vector& dv)
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	47 : MArray<double> (dv.as_column ()) { }
9612 66970dd627f6 further liboctave design improvements Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	48
11570 57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	49 ColumnVector (octave_idx_type n, double val)
57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	50 : MArray<double> (dim_vector (n, 1), val) { }
3585 d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3580 diff changeset	51
d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3580 diff changeset	52 ColumnVector (const ColumnVector& a) : MArray<double> (a) { }
d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3580 diff changeset	53
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	54 ColumnVector (const MArray<double>& a) : MArray<double> (a.as_column ()) { }
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	55 ColumnVector (const Array<double>& a) : MArray<double> (a.as_column ()) { }
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	56
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	57 ColumnVector& operator = (const ColumnVector& a)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	58 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	59 MArray<double>::operator = (a);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	60 return *this;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	61 }
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	62
2386 4fc9fd1424a9 [project @ 1996-10-12 18:31:34 by jwe] jwe parents: 1993 diff changeset	63 bool operator == (const ColumnVector& a) const;
4fc9fd1424a9 [project @ 1996-10-12 18:31:34 by jwe] jwe parents: 1993 diff changeset	64 bool operator != (const ColumnVector& a) const;
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	65
1359 a6994c934a50 [project @ 1995-09-05 21:30:26 by jwe] jwe parents: 1315 diff changeset	66 // destructive insert/delete/reorder operations
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	67
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	68 ColumnVector& insert (const ColumnVector& a, octave_idx_type r);
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	69
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	70 ColumnVector& fill (double val);
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	71 ColumnVector& fill (double val, octave_idx_type r1, octave_idx_type r2);
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	72
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	73 ColumnVector stack (const ColumnVector& a) const;
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	74
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	75 RowVector transpose (void) const;
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	76
6108 143b556ce725 [project @ 2006-10-27 01:45:54 by jwe] jwe parents: 5508 diff changeset	77 friend OCTAVE_API ColumnVector real (const ComplexColumnVector& a);
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe] jwe parents: 5508 diff changeset	78 friend OCTAVE_API ColumnVector imag (const ComplexColumnVector& a);
1205 8302fab9fe24 [project @ 1995-04-04 02:05:01 by jwe] jwe parents: 1011 diff changeset	79
1359 a6994c934a50 [project @ 1995-09-05 21:30:26 by jwe] jwe parents: 1315 diff changeset	80 // resize is the destructive equivalent for this one
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	81
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	82 ColumnVector extract (octave_idx_type r1, octave_idx_type r2) const;
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	83
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	84 ColumnVector extract_n (octave_idx_type r1, octave_idx_type n) const;
4316 236c10efcde2 [project @ 2003-02-10 21:57:15 by jwe] jwe parents: 4192 diff changeset	85
1359 a6994c934a50 [project @ 1995-09-05 21:30:26 by jwe] jwe parents: 1315 diff changeset	86 // matrix by column vector -> column vector operations
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	87
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	88 friend OCTAVE_API ColumnVector operator * (const Matrix& a,
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	89 const ColumnVector& b);
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	90
1359 a6994c934a50 [project @ 1995-09-05 21:30:26 by jwe] jwe parents: 1315 diff changeset	91 // diagonal matrix by column vector -> column vector operations
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	92
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	93 friend OCTAVE_API ColumnVector operator * (const DiagMatrix& a,
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	94 const ColumnVector& b);
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	95
1359 a6994c934a50 [project @ 1995-09-05 21:30:26 by jwe] jwe parents: 1315 diff changeset	96 // other operations
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	97
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	98 double min (void) const;
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	99 double max (void) const;
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	100
10363 a0728e81ed25 improve diag matrix interface & implementation Jaroslav Hajek <highegg@gmail.com> parents: 10350 diff changeset	101 ColumnVector abs (void) const;
a0728e81ed25 improve diag matrix interface & implementation Jaroslav Hajek <highegg@gmail.com> parents: 10350 diff changeset	102
1359 a6994c934a50 [project @ 1995-09-05 21:30:26 by jwe] jwe parents: 1315 diff changeset	103 // i/o
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	104
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	105 friend OCTAVE_API std::ostream& operator << (std::ostream& os,
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	106 const ColumnVector& a);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	107 friend OCTAVE_API std::istream& operator >> (std::istream& is,
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	108 ColumnVector& a);
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	109
14616 13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	110 void resize (octave_idx_type n, const double& rfv = 0)
11574 a83bad07f7e3 attempt better backward compatibility for Array resize functions John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	111 {
a83bad07f7e3 attempt better backward compatibility for Array resize functions John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	112 Array<double>::resize (dim_vector (n, 1), rfv);
a83bad07f7e3 attempt better backward compatibility for Array resize functions John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	113 }
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	114
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	115 void clear (octave_idx_type n)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	116 { Array<double>::clear (n, 1); }
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	117
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	118 };
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	119
5508 7865515fc6c2 [project @ 2005-10-26 15:24:07 by jwe] jwe parents: 5307 diff changeset	120 // Publish externally used friend functions.
7865515fc6c2 [project @ 2005-10-26 15:24:07 by jwe] jwe parents: 5307 diff changeset	121
6108 143b556ce725 [project @ 2006-10-27 01:45:54 by jwe] jwe parents: 5508 diff changeset	122 extern OCTAVE_API ColumnVector real (const ComplexColumnVector& a);
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe] jwe parents: 5508 diff changeset	123 extern OCTAVE_API ColumnVector imag (const ComplexColumnVector& a);
5508 7865515fc6c2 [project @ 2005-10-26 15:24:07 by jwe] jwe parents: 5307 diff changeset	124
3573 6ae6f1180e62 [project @ 2000-02-04 09:01:59 by jwe] jwe parents: 3504 diff changeset	125 MARRAY_FORWARD_DEFS (MArray, ColumnVector, double)
6ae6f1180e62 [project @ 2000-02-04 09:01:59 by jwe] jwe parents: 3504 diff changeset	126
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	127 #endif

Mercurial > octave

annotate liboctave/array/dColVector.h @ 27919:1891570abac8