octave-nkf: liboctave/array/CColVector.h annotate

annotate liboctave/array/CColVector.h @ 18260:9feb46ac6847

maint: Periodic merge of gui-release to default.

author	John W. Eaton <jwe@octave.org>
date	Tue, 07 Jan 2014 22:09:35 -0500
parents	ebb3ef964372
children	4197fc428c7d

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
17744 d63878346099 maint: Update copyright notices for release. John W. Eaton <jwe@octave.org> parents: 15271 diff changeset	3 Copyright (C) 1994-2013 John W. Eaton
10521 4d1fc073fbb7 add some missing copyright stmts Jaroslav Hajek <highegg@gmail.com> parents: 10364 diff changeset	4 Copyright (C) 2010 VZLU Prague
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	5
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	6 This file is part of Octave.
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	7
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	8 Octave is free software; you can redistribute it and/or modify it
38cb88095913 [project @ 1994-06-06 00:41:10 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: 6108 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: 6108 diff changeset	11 option) any later version.
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	12
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	13 Octave is distributed in the hope that it will be useful, but WITHOUT
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	16 for more details.
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	17
38cb88095913 [project @ 1994-06-06 00:41:10 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: 6108 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: 6108 diff changeset	20 <http://www.gnu.org/licenses/>.
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	21
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	22 */
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	23
17822 ebb3ef964372 maint: Use common #define syntax "octave_filename_h" in h_files. Rik <rik@octave.org> parents: 17769 diff changeset	24 #if !defined (octave_CColVector_h)
ebb3ef964372 maint: Use common #define syntax "octave_filename_h" in h_files. Rik <rik@octave.org> parents: 17769 diff changeset	25 #define octave_CColVector_h 1
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	26
1214 0bf4d2b7def4 [project @ 1995-04-06 02:33:59 by jwe] jwe parents: 1205 diff changeset	27 #include "MArray.h"
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	28
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	29 #include "mx-defs.h"
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	30
3585 d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3582 diff changeset	31 class
6108 143b556ce725 [project @ 2006-10-27 01:45:54 by jwe] jwe parents: 5307 diff changeset	32 OCTAVE_API
3585 d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3582 diff changeset	33 ComplexColumnVector : public MArray<Complex>
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	34 {
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	35 friend class ComplexMatrix;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	36 friend class ComplexRowVector;
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	37
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	38 public:
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	39
11570 57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	40 ComplexColumnVector (void) : MArray<Complex> (dim_vector (0, 1)) { }
3585 d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3582 diff changeset	41
11570 57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	42 explicit ComplexColumnVector (octave_idx_type n)
57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	43 : MArray<Complex> (dim_vector (n, 1)) { }
3585 d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3582 diff changeset	44
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11574 diff changeset	45 explicit ComplexColumnVector (const dim_vector& dv)
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	46 : MArray<Complex> (dv.as_column ()) { }
9612 66970dd627f6 further liboctave design improvements Jaroslav Hajek <highegg@gmail.com> parents: 9237 diff changeset	47
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	48 ComplexColumnVector (octave_idx_type n, const Complex& val)
11570 57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	49 : MArray<Complex> (dim_vector (n, 1), val) { }
3585 d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3582 diff changeset	50
d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3582 diff changeset	51 ComplexColumnVector (const ComplexColumnVector& a) : MArray<Complex> (a) { }
d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3582 diff changeset	52
11570 57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	53 ComplexColumnVector (const MArray<Complex>& a)
57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	54 : MArray<Complex> (a.as_column ()) { }
57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	55
57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	56 ComplexColumnVector (const Array<Complex>& a)
57632dea2446 attempt better backward compatibility for Array constructors John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	57 : MArray<Complex> (a.as_column ()) { }
3585 d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3582 diff changeset	58
d9803711e047 [project @ 2000-02-08 04:35:39 by jwe] jwe parents: 3582 diff changeset	59 explicit ComplexColumnVector (const ColumnVector& a);
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	60
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	61 ComplexColumnVector& operator = (const ComplexColumnVector& a)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	62 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	63 MArray<Complex>::operator = (a);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	64 return *this;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	65 }
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	66
2386 4fc9fd1424a9 [project @ 1996-10-12 18:31:34 by jwe] jwe parents: 1993 diff changeset	67 bool operator == (const ComplexColumnVector& a) const;
4fc9fd1424a9 [project @ 1996-10-12 18:31:34 by jwe] jwe parents: 1993 diff changeset	68 bool operator != (const ComplexColumnVector& a) const;
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	69
1359 a6994c934a50 [project @ 1995-09-05 21:30:26 by jwe] jwe parents: 1315 diff changeset	70 // destructive insert/delete/reorder operations
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	71
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	72 ComplexColumnVector& insert (const ColumnVector& a, octave_idx_type r);
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	73 ComplexColumnVector& insert (const ComplexColumnVector& a, octave_idx_type r);
458 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 ComplexColumnVector& fill (double val);
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	76 ComplexColumnVector& fill (const Complex& val);
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	77 ComplexColumnVector& fill (double val,
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	78 octave_idx_type r1, octave_idx_type r2);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	79 ComplexColumnVector& fill (const Complex& val,
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	80 octave_idx_type r1, octave_idx_type r2);
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	81
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	82 ComplexColumnVector stack (const ColumnVector& a) const;
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	83 ComplexColumnVector stack (const ComplexColumnVector& a) const;
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	84
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7503 diff changeset	85 ComplexRowVector hermitian (void) const;
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	86 ComplexRowVector transpose (void) const;
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	87
9237 3c1762c7e787 Add missing xxx_API decoration and remove misplaced ones Michael Goffioul <michael.goffioul@gmail.com> parents: 8920 diff changeset	88 friend OCTAVE_API ComplexColumnVector conj (const ComplexColumnVector& a);
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	89
1359 a6994c934a50 [project @ 1995-09-05 21:30:26 by jwe] jwe parents: 1315 diff changeset	90 // resize is the destructive equivalent for this one
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	91
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	92 ComplexColumnVector 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	93
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	94 ComplexColumnVector 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	95
1359 a6994c934a50 [project @ 1995-09-05 21:30:26 by jwe] jwe parents: 1315 diff changeset	96 // column vector by column vector -> column vector 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 ComplexColumnVector& operator += (const ColumnVector& a);
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	99 ComplexColumnVector& operator -= (const ColumnVector& a);
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	100
1359 a6994c934a50 [project @ 1995-09-05 21:30:26 by jwe] jwe parents: 1315 diff changeset	101 // matrix by column vector -> column vector operations
1205 8302fab9fe24 [project @ 1995-04-04 02:05:01 by jwe] jwe parents: 1011 diff changeset	102
9237 3c1762c7e787 Add missing xxx_API decoration and remove misplaced ones Michael Goffioul <michael.goffioul@gmail.com> parents: 8920 diff changeset	103 friend OCTAVE_API ComplexColumnVector operator * (const ComplexMatrix& a,
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	104 const ColumnVector& b);
1205 8302fab9fe24 [project @ 1995-04-04 02:05:01 by jwe] jwe parents: 1011 diff changeset	105
9237 3c1762c7e787 Add missing xxx_API decoration and remove misplaced ones Michael Goffioul <michael.goffioul@gmail.com> parents: 8920 diff changeset	106 friend OCTAVE_API ComplexColumnVector operator * (const ComplexMatrix& a,
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	107 const ComplexColumnVector& b);
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	108
1359 a6994c934a50 [project @ 1995-09-05 21:30:26 by jwe] jwe parents: 1315 diff changeset	109 // matrix by column vector -> column vector operations
1205 8302fab9fe24 [project @ 1995-04-04 02:05:01 by jwe] jwe parents: 1011 diff changeset	110
9237 3c1762c7e787 Add missing xxx_API decoration and remove misplaced ones Michael Goffioul <michael.goffioul@gmail.com> parents: 8920 diff changeset	111 friend OCTAVE_API ComplexColumnVector operator * (const Matrix& a,
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	112 const ComplexColumnVector& b);
1205 8302fab9fe24 [project @ 1995-04-04 02:05:01 by jwe] jwe parents: 1011 diff changeset	113
1359 a6994c934a50 [project @ 1995-09-05 21:30:26 by jwe] jwe parents: 1315 diff changeset	114 // diagonal matrix by column vector -> column vector operations
1205 8302fab9fe24 [project @ 1995-04-04 02:05:01 by jwe] jwe parents: 1011 diff changeset	115
9237 3c1762c7e787 Add missing xxx_API decoration and remove misplaced ones Michael Goffioul <michael.goffioul@gmail.com> parents: 8920 diff changeset	116 friend OCTAVE_API ComplexColumnVector operator * (const DiagMatrix& a,
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	117 const ComplexColumnVector& b);
1205 8302fab9fe24 [project @ 1995-04-04 02:05:01 by jwe] jwe parents: 1011 diff changeset	118
9237 3c1762c7e787 Add missing xxx_API decoration and remove misplaced ones Michael Goffioul <michael.goffioul@gmail.com> parents: 8920 diff changeset	119 friend OCTAVE_API ComplexColumnVector operator * (const ComplexDiagMatrix& a,
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	120 const ColumnVector& b);
1205 8302fab9fe24 [project @ 1995-04-04 02:05:01 by jwe] jwe parents: 1011 diff changeset	121
9237 3c1762c7e787 Add missing xxx_API decoration and remove misplaced ones Michael Goffioul <michael.goffioul@gmail.com> parents: 8920 diff changeset	122 friend OCTAVE_API ComplexColumnVector operator * (const ComplexDiagMatrix& a,
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	123 const ComplexColumnVector& b);
1205 8302fab9fe24 [project @ 1995-04-04 02:05:01 by jwe] jwe parents: 1011 diff changeset	124
1359 a6994c934a50 [project @ 1995-09-05 21:30:26 by jwe] jwe parents: 1315 diff changeset	125 // other operations
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	126
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	127 Complex min (void) const;
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	128 Complex max (void) const;
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	129
10363 a0728e81ed25 improve diag matrix interface & implementation Jaroslav Hajek <highegg@gmail.com> parents: 10350 diff changeset	130 ColumnVector abs (void) const;
a0728e81ed25 improve diag matrix interface & implementation Jaroslav Hajek <highegg@gmail.com> parents: 10350 diff changeset	131
1359 a6994c934a50 [project @ 1995-09-05 21:30:26 by jwe] jwe parents: 1315 diff changeset	132 // i/o
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	133
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	134 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	135 const ComplexColumnVector& a);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	136 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	137 ComplexColumnVector& a);
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	138
14616 13cc11418393 improve handling of default resize fill value for arrays John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	139 void resize (octave_idx_type n, const Complex& rfv = Complex (0))
11574 a83bad07f7e3 attempt better backward compatibility for Array resize functions John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	140 {
a83bad07f7e3 attempt better backward compatibility for Array resize functions John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	141 Array<Complex>::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	142 }
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	143
12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	144 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	145 { Array<Complex>::clear (n, 1); }
10350 12884915a8e4 merge MArray classes & improve Array interface Jaroslav Hajek <highegg@gmail.com> parents: 10312 diff changeset	146
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	147 };
38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	148
3573 6ae6f1180e62 [project @ 2000-02-04 09:01:59 by jwe] jwe parents: 3504 diff changeset	149 MARRAY_FORWARD_DEFS (MArray, ComplexColumnVector, Complex)
6ae6f1180e62 [project @ 2000-02-04 09:01:59 by jwe] jwe parents: 3504 diff changeset	150
458 38cb88095913 [project @ 1994-06-06 00:41:10 by jwe] jwe parents: diff changeset	151 #endif

Mercurial > hg > octave-nkf

annotate liboctave/array/CColVector.h @ 18260:9feb46ac6847