annotate liboctave/Range.h @ 8721:e9cb742df9eb

imported patch sort3.diff
author Jaroslav Hajek <highegg@gmail.com>
date Wed, 11 Feb 2009 15:25:53 +0100
parents 0131fa223dbc
children eb63fbe60fab
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
1 /*
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
2
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
3 Copyright (C) 1993, 1994, 1995, 1996, 1997, 2000, 2002, 2004, 2005,
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
4 2006, 2007 John W. Eaton
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
5
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
6 This file is part of Octave.
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
7
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
8 Octave is free software; you can redistribute it and/or modify it
9a4c07481e61 [project @ 1993-08-08 01:20:23 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.
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
12
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
13 Octave is distributed in the hope that it will be useful, but WITHOUT
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
16 for more details.
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
17
9a4c07481e61 [project @ 1993-08-08 01:20:23 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/>.
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
21
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
22 */
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
23
382
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 238
diff changeset
24 #if !defined (octave_Range_h)
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 238
diff changeset
25 #define octave_Range_h 1
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 238
diff changeset
26
3503
d14c483b3c12 [project @ 2000-02-01 04:06:07 by jwe]
jwe
parents: 2847
diff changeset
27 #include <iostream>
7458
1032e24f199f make sort work for ranges
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
28
4810
72a6d410a14a [project @ 2004-03-03 18:49:39 by jwe]
jwe
parents: 4192
diff changeset
29 #include "dMatrix.h"
7458
1032e24f199f make sort work for ranges
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
30 #include "oct-sort.h"
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
31
1860
821870c30840 [project @ 1996-02-04 10:04:58 by jwe]
jwe
parents: 1528
diff changeset
32 class
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5347
diff changeset
33 OCTAVE_API
1860
821870c30840 [project @ 1996-02-04 10:04:58 by jwe]
jwe
parents: 1528
diff changeset
34 Range
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
35 {
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
36 public:
1860
821870c30840 [project @ 1996-02-04 10:04:58 by jwe]
jwe
parents: 1528
diff changeset
37
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
38 Range (void)
5347
679cc8fec408 [project @ 2005-05-11 16:34:11 by jwe]
jwe
parents: 5307
diff changeset
39 : rng_base (0), rng_limit (0), rng_inc (0), rng_nelem (0), cache (1, 0) { }
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
40
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
41 Range (const Range& r)
1860
821870c30840 [project @ 1996-02-04 10:04:58 by jwe]
jwe
parents: 1528
diff changeset
42 : rng_base (r.rng_base), rng_limit (r.rng_limit), rng_inc (r.rng_inc),
4811
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
43 rng_nelem (r.rng_nelem), cache () { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
44
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
45 Range (double b, double l)
1860
821870c30840 [project @ 1996-02-04 10:04:58 by jwe]
jwe
parents: 1528
diff changeset
46 : rng_base (b), rng_limit (l), rng_inc (1),
4811
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
47 rng_nelem (nelem_internal ()), cache () { }
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
48
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
49 Range (double b, double l, double i)
1860
821870c30840 [project @ 1996-02-04 10:04:58 by jwe]
jwe
parents: 1528
diff changeset
50 : rng_base (b), rng_limit (l), rng_inc (i),
4811
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
51 rng_nelem (nelem_internal ()), cache () { }
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
52
8589
0131fa223dbc make length invariant in range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 8553
diff changeset
53 // For operators' usage (to preserve element count).
0131fa223dbc make length invariant in range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 8553
diff changeset
54 Range (double b, double i, octave_idx_type n)
0131fa223dbc make length invariant in range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 8553
diff changeset
55 : rng_base (b), rng_limit (b + n * i), rng_inc (i),
0131fa223dbc make length invariant in range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 8553
diff changeset
56 rng_nelem (n), cache () { }
0131fa223dbc make length invariant in range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 8553
diff changeset
57
4811
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
58 double base (void) const { return rng_base; }
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
59 double limit (void) const { return rng_limit; }
4811
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
60 double inc (void) const { return rng_inc; }
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 5105
diff changeset
61 octave_idx_type nelem (void) const { return rng_nelem; }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
62
2383
096529066838 [project @ 1996-10-12 17:50:47 by jwe]
jwe
parents: 1993
diff changeset
63 bool all_elements_are_ints (void) const;
096529066838 [project @ 1996-10-12 17:50:47 by jwe]
jwe
parents: 1993
diff changeset
64
645
21cb3c7dc9e3 [project @ 1994-08-24 06:19:54 by jwe]
jwe
parents: 461
diff changeset
65 Matrix matrix_value (void) const;
21cb3c7dc9e3 [project @ 1994-08-24 06:19:54 by jwe]
jwe
parents: 461
diff changeset
66
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
67 double min (void) const;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
68 double max (void) const;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
69
7458
1032e24f199f make sort work for ranges
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
70 void sort_internal (bool ascending = true);
1032e24f199f make sort work for ranges
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
71 void sort_internal (Array<octave_idx_type>& sidx, bool ascending = true);
1032e24f199f make sort work for ranges
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
72
7620
36594d5bbe13 Move diag function into the octave_value class
David Bateman <dbateman@free.fr>
parents: 7463
diff changeset
73 Matrix diag (octave_idx_type k = 0) const;
36594d5bbe13 Move diag function into the octave_value class
David Bateman <dbateman@free.fr>
parents: 7463
diff changeset
74
7463
2467639bd8c0 eliminate UNDEFINED sort mode
John W. Eaton <jwe@octave.org>
parents: 7458
diff changeset
75 Range sort (octave_idx_type dim = 0, sortmode mode = ASCENDING) const;
7458
1032e24f199f make sort work for ranges
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
76
1032e24f199f make sort work for ranges
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
77 Range sort (Array<octave_idx_type>& sidx, octave_idx_type dim = 0,
7463
2467639bd8c0 eliminate UNDEFINED sort mode
John W. Eaton <jwe@octave.org>
parents: 7458
diff changeset
78 sortmode mode = ASCENDING) const;
208
380cb9ccc889 [project @ 1993-11-12 10:35:05 by jwe]
jwe
parents: 3
diff changeset
79
8721
e9cb742df9eb imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents: 8589
diff changeset
80 sortmode is_sorted (sortmode mode = ASCENDING) const;
e9cb742df9eb imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents: 8589
diff changeset
81
4811
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
82 void set_base (double b)
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
83 {
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
84 if (rng_base != b)
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
85 {
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
86 rng_base = b;
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
87 clear_cache ();
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
88 }
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
89 }
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
90
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
91 void set_limit (double l)
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
92 {
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
93 if (rng_limit != l)
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
94 {
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
95 rng_limit = l;
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
96 clear_cache ();
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
97 }
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
98 }
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
99
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
100 void set_inc (double i)
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
101 {
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
102 if (rng_inc != i)
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
103 {
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
104 rng_inc = i;
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
105 clear_cache ();
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
106 }
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
107 }
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
108
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5347
diff changeset
109 friend OCTAVE_API std::ostream& operator << (std::ostream& os, const Range& r);
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5347
diff changeset
110 friend OCTAVE_API std::istream& operator >> (std::istream& is, Range& r);
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
111
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
112 void print_range (void);
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
113
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
114 private:
1860
821870c30840 [project @ 1996-02-04 10:04:58 by jwe]
jwe
parents: 1528
diff changeset
115
208
380cb9ccc889 [project @ 1993-11-12 10:35:05 by jwe]
jwe
parents: 3
diff changeset
116 double rng_base;
380cb9ccc889 [project @ 1993-11-12 10:35:05 by jwe]
jwe
parents: 3
diff changeset
117 double rng_limit;
380cb9ccc889 [project @ 1993-11-12 10:35:05 by jwe]
jwe
parents: 3
diff changeset
118 double rng_inc;
1860
821870c30840 [project @ 1996-02-04 10:04:58 by jwe]
jwe
parents: 1528
diff changeset
119
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 5105
diff changeset
120 octave_idx_type rng_nelem;
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
121
4811
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
122 mutable Matrix cache;
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
123
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 5105
diff changeset
124 octave_idx_type nelem_internal (void) const;
4811
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
125
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
126 void clear_cache (void) const { cache.resize (0, 0); }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
127 };
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
128
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5347
diff changeset
129 extern OCTAVE_API Range operator - (const Range& r);
2599
9705ea40f0a2 [project @ 1996-12-19 04:49:09 by jwe]
jwe
parents: 2383
diff changeset
130
8553
c7ff200e45f5 optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 7620
diff changeset
131 extern OCTAVE_API Range operator + (double x, const Range& r);
c7ff200e45f5 optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 7620
diff changeset
132
c7ff200e45f5 optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 7620
diff changeset
133 extern OCTAVE_API Range operator + (const Range& r, double x);
c7ff200e45f5 optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 7620
diff changeset
134
c7ff200e45f5 optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 7620
diff changeset
135 extern OCTAVE_API Range operator - (double x, const Range& r);
c7ff200e45f5 optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 7620
diff changeset
136
c7ff200e45f5 optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 7620
diff changeset
137 extern OCTAVE_API Range operator - (const Range& r, double x);
c7ff200e45f5 optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 7620
diff changeset
138
c7ff200e45f5 optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 7620
diff changeset
139 extern OCTAVE_API Range operator * (double x, const Range& r);
c7ff200e45f5 optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 7620
diff changeset
140
c7ff200e45f5 optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 7620
diff changeset
141 extern OCTAVE_API Range operator * (const Range& r, double x);
c7ff200e45f5 optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 7620
diff changeset
142
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
143 #endif
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
144
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
145 /*
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
146 ;;; Local Variables: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
147 ;;; mode: C++ ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
148 ;;; End: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
149 */