annotate liboctave/Range.h @ 5307:4c8a2e4e0717

[project @ 2005-04-26 19:24:27 by jwe]
author jwe
date Tue, 26 Apr 2005 19:24:47 +0000
parents 23b37da9fd5b
children 679cc8fec408
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
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 2599
diff changeset
3 Copyright (C) 1996, 1997 John W. Eaton
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
4
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
6
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
7 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
8 under the terms of the GNU General Public License as published by the
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
10 later version.
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
11
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
12 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
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
14 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
15 for more details.
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
16
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5275
diff changeset
19 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5275
diff changeset
20 02110-1301, USA.
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>
4810
72a6d410a14a [project @ 2004-03-03 18:49:39 by jwe]
jwe
parents: 4192
diff changeset
28 #include "dMatrix.h"
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
29
1860
821870c30840 [project @ 1996-02-04 10:04:58 by jwe]
jwe
parents: 1528
diff changeset
30 class
821870c30840 [project @ 1996-02-04 10:04:58 by jwe]
jwe
parents: 1528
diff changeset
31 Range
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
32 {
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
33 public:
1860
821870c30840 [project @ 1996-02-04 10:04:58 by jwe]
jwe
parents: 1528
diff changeset
34
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
35 Range (void)
4811
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
36 : rng_base (-1), rng_limit (-1), rng_inc (-1), rng_nelem (-1), cache () { }
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
37
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
38 Range (const Range& r)
1860
821870c30840 [project @ 1996-02-04 10:04:58 by jwe]
jwe
parents: 1528
diff changeset
39 : 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
40 rng_nelem (r.rng_nelem), cache () { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
41
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
42 Range (double b, double l)
1860
821870c30840 [project @ 1996-02-04 10:04:58 by jwe]
jwe
parents: 1528
diff changeset
43 : 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
44 rng_nelem (nelem_internal ()), cache () { }
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
45
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
46 Range (double b, double l, double i)
1860
821870c30840 [project @ 1996-02-04 10:04:58 by jwe]
jwe
parents: 1528
diff changeset
47 : 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
48 rng_nelem (nelem_internal ()), cache () { }
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
49
4811
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
50 double base (void) const { return rng_base; }
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
51 double limit (void) const { return rng_limit; }
4811
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
52 double inc (void) const { return rng_inc; }
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 5105
diff changeset
53 octave_idx_type nelem (void) const { return rng_nelem; }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
54
2383
096529066838 [project @ 1996-10-12 17:50:47 by jwe]
jwe
parents: 1993
diff changeset
55 bool all_elements_are_ints (void) const;
096529066838 [project @ 1996-10-12 17:50:47 by jwe]
jwe
parents: 1993
diff changeset
56
645
21cb3c7dc9e3 [project @ 1994-08-24 06:19:54 by jwe]
jwe
parents: 461
diff changeset
57 Matrix matrix_value (void) const;
21cb3c7dc9e3 [project @ 1994-08-24 06:19:54 by jwe]
jwe
parents: 461
diff changeset
58
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
59 double min (void) const;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
60 double max (void) const;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
61
208
380cb9ccc889 [project @ 1993-11-12 10:35:05 by jwe]
jwe
parents: 3
diff changeset
62 void sort (void);
380cb9ccc889 [project @ 1993-11-12 10:35:05 by jwe]
jwe
parents: 3
diff changeset
63
4811
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
64 void set_base (double b)
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
65 {
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
66 if (rng_base != b)
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
67 {
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
68 rng_base = b;
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
69 clear_cache ();
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
70 }
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
71 }
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
72
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
73 void set_limit (double l)
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
74 {
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
75 if (rng_limit != l)
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
76 {
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
77 rng_limit = l;
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
78 clear_cache ();
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
79 }
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
80 }
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
81
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
82 void set_inc (double i)
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_inc != i)
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_inc = i;
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 }
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
90
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3503
diff changeset
91 friend std::ostream& operator << (std::ostream& os, const Range& r);
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3503
diff changeset
92 friend std::istream& operator >> (std::istream& is, Range& r);
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
93
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
94 void print_range (void);
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
95
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
96 private:
1860
821870c30840 [project @ 1996-02-04 10:04:58 by jwe]
jwe
parents: 1528
diff changeset
97
208
380cb9ccc889 [project @ 1993-11-12 10:35:05 by jwe]
jwe
parents: 3
diff changeset
98 double rng_base;
380cb9ccc889 [project @ 1993-11-12 10:35:05 by jwe]
jwe
parents: 3
diff changeset
99 double rng_limit;
380cb9ccc889 [project @ 1993-11-12 10:35:05 by jwe]
jwe
parents: 3
diff changeset
100 double rng_inc;
1860
821870c30840 [project @ 1996-02-04 10:04:58 by jwe]
jwe
parents: 1528
diff changeset
101
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 5105
diff changeset
102 octave_idx_type rng_nelem;
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
103
4811
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
104 mutable Matrix cache;
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
105
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 5105
diff changeset
106 octave_idx_type nelem_internal (void) const;
4811
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
107
198f3712c692 [project @ 2004-03-03 19:24:33 by jwe]
jwe
parents: 4810
diff changeset
108 void clear_cache (void) const { cache.resize (0, 0); }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
109 };
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
110
2599
9705ea40f0a2 [project @ 1996-12-19 04:49:09 by jwe]
jwe
parents: 2383
diff changeset
111 extern Range operator - (const Range& r);
9705ea40f0a2 [project @ 1996-12-19 04:49:09 by jwe]
jwe
parents: 2383
diff changeset
112
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
113 #endif
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
114
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
115 /*
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
116 ;;; Local Variables: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
117 ;;; mode: C++ ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
118 ;;; End: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
119 */