Mercurial > octave-nkf
annotate liboctave/Range.h @ 11523:fd0a3ac60b0e
update copyright notices
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Fri, 14 Jan 2011 05:47:45 -0500 |
| parents | cbc402e64d83 |
| children | 72c96de7a403 |
| rev | line source |
|---|---|
| 3 | 1 /* |
| 2 | |
| 11523 | 3 Copyright (C) 1993-2011 John W. Eaton |
| 3 | 4 |
| 5 This file is part of Octave. | |
| 6 | |
| 7 Octave is free software; you can redistribute it and/or modify it | |
| 8 under the terms of the GNU General Public License as published by the | |
| 7016 | 9 Free Software Foundation; either version 3 of the License, or (at your |
| 10 option) any later version. | |
| 3 | 11 |
| 12 Octave is distributed in the hope that it will be useful, but WITHOUT | |
| 13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 15 for more details. | |
| 16 | |
| 17 You should have received a copy of the GNU General Public License | |
| 7016 | 18 along with Octave; see the file COPYING. If not, see |
| 19 <http://www.gnu.org/licenses/>. | |
| 3 | 20 |
| 21 */ | |
| 22 | |
| 382 | 23 #if !defined (octave_Range_h) |
| 24 #define octave_Range_h 1 | |
| 25 | |
|
8950
d865363208d6
include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
26 #include <iosfwd> |
| 7458 | 27 |
| 4810 | 28 #include "dMatrix.h" |
| 7458 | 29 #include "oct-sort.h" |
| 3 | 30 |
| 1860 | 31 class |
| 6108 | 32 OCTAVE_API |
| 1860 | 33 Range |
| 3 | 34 { |
| 35 public: | |
| 1860 | 36 |
| 1528 | 37 Range (void) |
| 5347 | 38 : rng_base (0), rng_limit (0), rng_inc (0), rng_nelem (0), cache (1, 0) { } |
| 1528 | 39 |
| 40 Range (const Range& r) | |
| 1860 | 41 : rng_base (r.rng_base), rng_limit (r.rng_limit), rng_inc (r.rng_inc), |
| 8971 | 42 rng_nelem (r.rng_nelem), cache (r.cache) { } |
| 3 | 43 |
| 1528 | 44 Range (double b, double l) |
| 1860 | 45 : rng_base (b), rng_limit (l), rng_inc (1), |
| 4811 | 46 rng_nelem (nelem_internal ()), cache () { } |
| 1528 | 47 |
| 48 Range (double b, double l, double i) | |
| 1860 | 49 : rng_base (b), rng_limit (l), rng_inc (i), |
| 4811 | 50 rng_nelem (nelem_internal ()), cache () { } |
| 1528 | 51 |
|
8589
0131fa223dbc
make length invariant in range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents:
8553
diff
changeset
|
52 // For operators' usage (to preserve element count). |
| 8971 | 53 Range (double b, double i, octave_idx_type n); |
|
8589
0131fa223dbc
make length invariant in range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents:
8553
diff
changeset
|
54 |
| 4811 | 55 double base (void) const { return rng_base; } |
| 1528 | 56 double limit (void) const { return rng_limit; } |
| 4811 | 57 double inc (void) const { return rng_inc; } |
| 5275 | 58 octave_idx_type nelem (void) const { return rng_nelem; } |
| 3 | 59 |
| 2383 | 60 bool all_elements_are_ints (void) const; |
| 61 | |
| 645 | 62 Matrix matrix_value (void) const; |
| 63 | |
| 3 | 64 double min (void) const; |
| 65 double max (void) const; | |
| 66 | |
| 7458 | 67 void sort_internal (bool ascending = true); |
| 68 void sort_internal (Array<octave_idx_type>& sidx, bool ascending = true); | |
| 69 | |
|
7620
36594d5bbe13
Move diag function into the octave_value class
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
70 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
|
71 |
|
7463
2467639bd8c0
eliminate UNDEFINED sort mode
John W. Eaton <jwe@octave.org>
parents:
7458
diff
changeset
|
72 Range sort (octave_idx_type dim = 0, sortmode mode = ASCENDING) const; |
| 7458 | 73 |
| 74 Range sort (Array<octave_idx_type>& sidx, octave_idx_type dim = 0, | |
|
10312
cbc402e64d83
untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents:
10158
diff
changeset
|
75 sortmode mode = ASCENDING) const; |
| 208 | 76 |
|
8721
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8589
diff
changeset
|
77 sortmode is_sorted (sortmode mode = ASCENDING) const; |
|
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8589
diff
changeset
|
78 |
|
9986
672e1b49e01e
optimize indexing of ranges by single subscripts
Jaroslav Hajek <highegg@gmail.com>
parents:
8971
diff
changeset
|
79 // Support for single-index subscripting, without generating matrix cache. |
|
672e1b49e01e
optimize indexing of ranges by single subscripts
Jaroslav Hajek <highegg@gmail.com>
parents:
8971
diff
changeset
|
80 |
|
672e1b49e01e
optimize indexing of ranges by single subscripts
Jaroslav Hajek <highegg@gmail.com>
parents:
8971
diff
changeset
|
81 double checkelem (octave_idx_type i) const; |
|
672e1b49e01e
optimize indexing of ranges by single subscripts
Jaroslav Hajek <highegg@gmail.com>
parents:
8971
diff
changeset
|
82 |
|
672e1b49e01e
optimize indexing of ranges by single subscripts
Jaroslav Hajek <highegg@gmail.com>
parents:
8971
diff
changeset
|
83 double elem (octave_idx_type i) const |
|
672e1b49e01e
optimize indexing of ranges by single subscripts
Jaroslav Hajek <highegg@gmail.com>
parents:
8971
diff
changeset
|
84 { |
|
672e1b49e01e
optimize indexing of ranges by single subscripts
Jaroslav Hajek <highegg@gmail.com>
parents:
8971
diff
changeset
|
85 #if defined (BOUNDS_CHECKING) |
|
672e1b49e01e
optimize indexing of ranges by single subscripts
Jaroslav Hajek <highegg@gmail.com>
parents:
8971
diff
changeset
|
86 return checkelem (i); |
|
672e1b49e01e
optimize indexing of ranges by single subscripts
Jaroslav Hajek <highegg@gmail.com>
parents:
8971
diff
changeset
|
87 #else |
|
672e1b49e01e
optimize indexing of ranges by single subscripts
Jaroslav Hajek <highegg@gmail.com>
parents:
8971
diff
changeset
|
88 return rng_base + rng_inc * i; |
|
672e1b49e01e
optimize indexing of ranges by single subscripts
Jaroslav Hajek <highegg@gmail.com>
parents:
8971
diff
changeset
|
89 #endif |
|
672e1b49e01e
optimize indexing of ranges by single subscripts
Jaroslav Hajek <highegg@gmail.com>
parents:
8971
diff
changeset
|
90 } |
|
672e1b49e01e
optimize indexing of ranges by single subscripts
Jaroslav Hajek <highegg@gmail.com>
parents:
8971
diff
changeset
|
91 |
|
672e1b49e01e
optimize indexing of ranges by single subscripts
Jaroslav Hajek <highegg@gmail.com>
parents:
8971
diff
changeset
|
92 Array<double> index (const idx_vector& i) const; |
|
672e1b49e01e
optimize indexing of ranges by single subscripts
Jaroslav Hajek <highegg@gmail.com>
parents:
8971
diff
changeset
|
93 |
| 4811 | 94 void set_base (double b) |
| 95 { | |
| 96 if (rng_base != b) | |
| 97 { | |
|
10312
cbc402e64d83
untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents:
10158
diff
changeset
|
98 rng_base = b; |
|
cbc402e64d83
untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents:
10158
diff
changeset
|
99 clear_cache (); |
| 4811 | 100 } |
| 101 } | |
| 102 | |
| 103 void set_limit (double l) | |
| 104 { | |
| 105 if (rng_limit != l) | |
| 106 { | |
|
10312
cbc402e64d83
untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents:
10158
diff
changeset
|
107 rng_limit = l; |
|
cbc402e64d83
untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents:
10158
diff
changeset
|
108 clear_cache (); |
| 4811 | 109 } |
| 110 } | |
| 111 | |
| 112 void set_inc (double i) | |
| 113 { | |
| 114 if (rng_inc != i) | |
| 115 { | |
|
10312
cbc402e64d83
untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents:
10158
diff
changeset
|
116 rng_inc = i; |
|
cbc402e64d83
untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents:
10158
diff
changeset
|
117 clear_cache (); |
| 4811 | 118 } |
| 119 } | |
| 1528 | 120 |
| 6108 | 121 friend OCTAVE_API std::ostream& operator << (std::ostream& os, const Range& r); |
| 122 friend OCTAVE_API std::istream& operator >> (std::istream& is, Range& r); | |
| 3 | 123 |
| 8971 | 124 friend OCTAVE_API Range operator - (const Range& r); |
| 125 friend OCTAVE_API Range operator + (double x, const Range& r); | |
| 126 friend OCTAVE_API Range operator + (const Range& r, double x); | |
| 127 friend OCTAVE_API Range operator - (double x, const Range& r); | |
| 128 friend OCTAVE_API Range operator - (const Range& r, double x); | |
| 129 friend OCTAVE_API Range operator * (double x, const Range& r); | |
| 130 friend OCTAVE_API Range operator * (const Range& r, double x); | |
| 131 | |
| 3 | 132 void print_range (void); |
| 133 | |
| 134 private: | |
| 1860 | 135 |
| 208 | 136 double rng_base; |
| 137 double rng_limit; | |
| 138 double rng_inc; | |
| 1860 | 139 |
| 5275 | 140 octave_idx_type rng_nelem; |
| 3 | 141 |
| 4811 | 142 mutable Matrix cache; |
| 143 | |
| 5275 | 144 octave_idx_type nelem_internal (void) const; |
| 4811 | 145 |
| 146 void clear_cache (void) const { cache.resize (0, 0); } | |
| 8971 | 147 |
| 3 | 148 }; |
| 149 | |
| 6108 | 150 extern OCTAVE_API Range operator - (const Range& r); |
| 2599 | 151 |
|
8553
c7ff200e45f5
optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents:
7620
diff
changeset
|
152 extern OCTAVE_API Range operator + (double x, const Range& r); |
|
c7ff200e45f5
optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents:
7620
diff
changeset
|
153 |
|
c7ff200e45f5
optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents:
7620
diff
changeset
|
154 extern OCTAVE_API Range operator + (const Range& r, double x); |
|
c7ff200e45f5
optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents:
7620
diff
changeset
|
155 |
|
c7ff200e45f5
optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents:
7620
diff
changeset
|
156 extern OCTAVE_API Range operator - (double x, const Range& r); |
|
c7ff200e45f5
optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents:
7620
diff
changeset
|
157 |
|
c7ff200e45f5
optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents:
7620
diff
changeset
|
158 extern OCTAVE_API Range operator - (const Range& r, double x); |
|
c7ff200e45f5
optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents:
7620
diff
changeset
|
159 |
|
c7ff200e45f5
optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents:
7620
diff
changeset
|
160 extern OCTAVE_API Range operator * (double x, const Range& r); |
|
c7ff200e45f5
optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents:
7620
diff
changeset
|
161 |
|
c7ff200e45f5
optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents:
7620
diff
changeset
|
162 extern OCTAVE_API Range operator * (const Range& r, double x); |
|
c7ff200e45f5
optimize range-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents:
7620
diff
changeset
|
163 |
| 3 | 164 #endif |