← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/qwt/oneiric-proposed

« back to all changes in this revision

Viewing changes to qwt-5.1.2/doc/man/man3/QwtDoubleInterval.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2009-04-12 23:25:58 UTC
  • mfrom: (1.1.4 upstream) (2.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090412232558-3bl06x785yr8xm8u
Tags: 5.1.2-1
* New upstream release.
* Bump compat/debhelper to 7.
* Bump Standards-Version to 3.8.1. No changes needed.
* Invert Maintainers and Uploaders field.
* Fix lintian warnings:
  - dh_clean _k deprecated.
  - missing dependency on libc.

Show diffs side-by-side

added added

removed removed

Lines of Context:
qwt-5.1.2/doc/man/man3/QwtDoubleInterval.3
 
1
.TH "QwtDoubleInterval" 3 "22 Mar 2009" "Version 5.1.2" "Qwt User's Guide" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
QwtDoubleInterval \- 
 
6
.SH SYNOPSIS
 
7
.br
 
8
.PP
 
9
.SH "Detailed Description"
 
10
.PP 
 
11
A class representing an interval. 
 
12
 
 
13
The interval is represented by 2 doubles, the lower and the upper limit. 
 
14
.PP
 
15
Definition at line 21 of file qwt_double_interval.h.
 
16
.SS "Public Member Functions"
 
17
 
 
18
.in +1c
 
19
.ti -1c
 
20
.RI "\fBQwtDoubleInterval\fP ()"
 
21
.br
 
22
.ti -1c
 
23
.RI "\fBQwtDoubleInterval\fP (double minValue, double maxValue)"
 
24
.br
 
25
.ti -1c
 
26
.RI "void \fBsetInterval\fP (double minValue, double maxValue)"
 
27
.br
 
28
.ti -1c
 
29
.RI "\fBQwtDoubleInterval\fP \fBnormalized\fP () const"
 
30
.br
 
31
.ti -1c
 
32
.RI "\fBQwtDoubleInterval\fP \fBinverted\fP () const"
 
33
.br
 
34
.ti -1c
 
35
.RI "\fBQwtDoubleInterval\fP \fBlimited\fP (double minValue, double maxValue) const"
 
36
.br
 
37
.ti -1c
 
38
.RI "int \fBoperator==\fP (const \fBQwtDoubleInterval\fP &) const"
 
39
.br
 
40
.ti -1c
 
41
.RI "int \fBoperator!=\fP (const \fBQwtDoubleInterval\fP &) const"
 
42
.br
 
43
.ti -1c
 
44
.RI "double \fBminValue\fP () const"
 
45
.br
 
46
.ti -1c
 
47
.RI "double \fBmaxValue\fP () const"
 
48
.br
 
49
.ti -1c
 
50
.RI "double \fBwidth\fP () const"
 
51
.br
 
52
.ti -1c
 
53
.RI "void \fBsetMinValue\fP (double)"
 
54
.br
 
55
.ti -1c
 
56
.RI "void \fBsetMaxValue\fP (double)"
 
57
.br
 
58
.ti -1c
 
59
.RI "bool \fBcontains\fP (double value) const "
 
60
.br
 
61
.ti -1c
 
62
.RI "bool \fBintersects\fP (const \fBQwtDoubleInterval\fP &) const"
 
63
.br
 
64
.ti -1c
 
65
.RI "\fBQwtDoubleInterval\fP \fBintersect\fP (const \fBQwtDoubleInterval\fP &) const"
 
66
.br
 
67
.ti -1c
 
68
.RI "\fBQwtDoubleInterval\fP \fBunite\fP (const \fBQwtDoubleInterval\fP &) const"
 
69
.br
 
70
.ti -1c
 
71
.RI "\fBQwtDoubleInterval\fP \fBoperator|\fP (const \fBQwtDoubleInterval\fP &) const"
 
72
.br
 
73
.ti -1c
 
74
.RI "\fBQwtDoubleInterval\fP \fBoperator &\fP (const \fBQwtDoubleInterval\fP &) const"
 
75
.br
 
76
.ti -1c
 
77
.RI "\fBQwtDoubleInterval\fP & \fBoperator|=\fP (const \fBQwtDoubleInterval\fP &)"
 
78
.br
 
79
.ti -1c
 
80
.RI "\fBQwtDoubleInterval\fP & \fBoperator &=\fP (const \fBQwtDoubleInterval\fP &)"
 
81
.br
 
82
.ti -1c
 
83
.RI "\fBQwtDoubleInterval\fP \fBextend\fP (double value) const "
 
84
.br
 
85
.ti -1c
 
86
.RI "\fBQwtDoubleInterval\fP \fBoperator|\fP (double) const"
 
87
.br
 
88
.ti -1c
 
89
.RI "\fBQwtDoubleInterval\fP & \fBoperator|=\fP (double)"
 
90
.br
 
91
.ti -1c
 
92
.RI "bool \fBisValid\fP () const"
 
93
.br
 
94
.ti -1c
 
95
.RI "bool \fBisNull\fP () const"
 
96
.br
 
97
.ti -1c
 
98
.RI "void \fBinvalidate\fP ()"
 
99
.br
 
100
.ti -1c
 
101
.RI "\fBQwtDoubleInterval\fP \fBsymmetrize\fP (double value) const "
 
102
.br
 
103
.in -1c
 
104
.SH "Constructor & Destructor Documentation"
 
105
.PP 
 
106
.SS "QwtDoubleInterval::QwtDoubleInterval ()\fC [inline]\fP"
 
107
.PP
 
108
Default Constructor. 
 
109
.PP
 
110
Creates an invalid interval [0.0, -1.0] 
 
111
.PP
 
112
\fBSee also:\fP
 
113
.RS 4
 
114
\fBsetInterval\fP, \fBisValid\fP 
 
115
.RE
 
116
.PP
 
117
 
 
118
.PP
 
119
Definition at line 77 of file qwt_double_interval.h.
 
120
.PP
 
121
Referenced by extend(), intersect(), inverted(), limited(), normalized(), symmetrize(), and unite().
 
122
.SS "QwtDoubleInterval::QwtDoubleInterval (double minValue, double maxValue)\fC [inline]\fP"
 
123
.PP
 
124
Constructor
 
125
.PP
 
126
\fBParameters:\fP
 
127
.RS 4
 
128
\fIminValue\fP Minimum value 
 
129
.br
 
130
\fImaxValue\fP Maximum value 
 
131
.RE
 
132
.PP
 
133
 
 
134
.PP
 
135
Definition at line 89 of file qwt_double_interval.h.
 
136
.SH "Member Function Documentation"
 
137
.PP 
 
138
.SS "void QwtDoubleInterval::setInterval (double minValue, double maxValue)\fC [inline]\fP"
 
139
.PP
 
140
Assign the limits of the interval
 
141
.PP
 
142
\fBParameters:\fP
 
143
.RS 4
 
144
\fIminValue\fP Minimum value 
 
145
.br
 
146
\fImaxValue\fP Maximum value 
 
147
.RE
 
148
.PP
 
149
 
 
150
.PP
 
151
Definition at line 101 of file qwt_double_interval.h.
 
152
.PP
 
153
Referenced by QwtLog10ScaleEngine::autoScale().
 
154
.SS "\fBQwtDoubleInterval\fP QwtDoubleInterval::normalized () const"
 
155
.PP
 
156
Normalize the limits of the interval. 
 
157
.PP
 
158
If \fBmaxValue()\fP < \fBminValue()\fP the limits will be inverted. 
 
159
.PP
 
160
\fBReturns:\fP
 
161
.RS 4
 
162
Normalized interval
 
163
.RE
 
164
.PP
 
165
\fBSee also:\fP
 
166
.RS 4
 
167
\fBisValid\fP, \fBinverted\fP 
 
168
.RE
 
169
.PP
 
170
 
 
171
.PP
 
172
Definition at line 28 of file qwt_double_interval.cpp.
 
173
.PP
 
174
References isValid(), and QwtDoubleInterval().
 
175
.PP
 
176
Referenced by QwtLinearScaleEngine::autoScale(), and QwtLog10ScaleEngine::divideScale().
 
177
.SS "\fBQwtDoubleInterval\fP QwtDoubleInterval::inverted () const"
 
178
.PP
 
179
Invert the limits of the interval 
 
180
.PP
 
181
\fBReturns:\fP
 
182
.RS 4
 
183
Inverted interval 
 
184
.RE
 
185
.PP
 
186
\fBSee also:\fP
 
187
.RS 4
 
188
\fBnormalized\fP 
 
189
.RE
 
190
.PP
 
191
 
 
192
.PP
 
193
Definition at line 43 of file qwt_double_interval.cpp.
 
194
.PP
 
195
References QwtDoubleInterval().
 
196
.SS "\fBQwtDoubleInterval\fP QwtDoubleInterval::limited (double lBound, double hBound) const"
 
197
.PP
 
198
Limit the interval
 
199
.PP
 
200
\fBParameters:\fP
 
201
.RS 4
 
202
\fIlBound\fP Lower limit 
 
203
.br
 
204
\fIhBound\fP Upper limit
 
205
.RE
 
206
.PP
 
207
\fBReturns:\fP
 
208
.RS 4
 
209
Limited interval 
 
210
.RE
 
211
.PP
 
212
 
 
213
.PP
 
214
Definition at line 159 of file qwt_double_interval.cpp.
 
215
.PP
 
216
References isValid(), maxValue(), minValue(), and QwtDoubleInterval().
 
217
.PP
 
218
Referenced by QwtLog10ScaleEngine::autoScale(), and QwtLog10ScaleEngine::divideScale().
 
219
.SS "int QwtDoubleInterval::operator== (const \fBQwtDoubleInterval\fP &) const\fC [inline]\fP"
 
220
.PP
 
221
Compare two intervals. 
 
222
.PP
 
223
Definition at line 172 of file qwt_double_interval.h.
 
224
.PP
 
225
References d_maxValue, and d_minValue.
 
226
.SS "int QwtDoubleInterval::operator!= (const \fBQwtDoubleInterval\fP &) const\fC [inline]\fP"
 
227
.PP
 
228
Compare two intervals. 
 
229
.PP
 
230
Definition at line 179 of file qwt_double_interval.h.
 
231
.SS "double QwtDoubleInterval::minValue () const\fC [inline]\fP"
 
232
.PP
 
233
\fBReturns:\fP
 
234
.RS 4
 
235
Lower limit of the interval 
 
236
.RE
 
237
.PP
 
238
 
 
239
.PP
 
240
Definition at line 128 of file qwt_double_interval.h.
 
241
.PP
 
242
Referenced by QwtLinearScaleEngine::align(), QwtLog10ScaleEngine::autoScale(), QwtLinearScaleEngine::autoScale(), QwtLinearColorMap::colorIndex(), QwtColorMap::colorTable(), QwtScaleEngine::contains(), QwtLog10ScaleEngine::divideScale(), intersect(), intersects(), limited(), QwtLog10ScaleEngine::log10(), QwtLog10ScaleEngine::pow10(), QwtAlphaColorMap::rgb(), QwtLinearColorMap::rgb(), QwtScaleDiv::setInterval(), QwtAbstractScale::setScale(), unite(), and QwtPlot::updateAxes().
 
243
.SS "double QwtDoubleInterval::maxValue () const\fC [inline]\fP"
 
244
.PP
 
245
\fBReturns:\fP
 
246
.RS 4
 
247
Upper limit of the interval 
 
248
.RE
 
249
.PP
 
250
 
 
251
.PP
 
252
Definition at line 134 of file qwt_double_interval.h.
 
253
.PP
 
254
Referenced by QwtLinearScaleEngine::align(), QwtLog10ScaleEngine::autoScale(), QwtLinearScaleEngine::autoScale(), QwtLinearColorMap::colorIndex(), QwtScaleEngine::contains(), QwtLog10ScaleEngine::divideScale(), intersect(), intersects(), limited(), QwtLog10ScaleEngine::log10(), QwtLog10ScaleEngine::pow10(), QwtScaleDiv::setInterval(), QwtAbstractScale::setScale(), unite(), and QwtPlot::updateAxes().
 
255
.SS "double QwtDoubleInterval::width () const\fC [inline]\fP"
 
256
.PP
 
257
Return the width of an interval The width of invalid intervals is 0.0, otherwise the result is \fBmaxValue()\fP - \fBminValue()\fP.
 
258
.PP
 
259
\fBSee also:\fP
 
260
.RS 4
 
261
\fBisValid\fP 
 
262
.RE
 
263
.PP
 
264
 
 
265
.PP
 
266
Definition at line 146 of file qwt_double_interval.h.
 
267
.PP
 
268
References isValid().
 
269
.PP
 
270
Referenced by QwtLog10ScaleEngine::autoScale(), QwtLinearScaleEngine::autoScale(), QwtLinearColorMap::colorIndex(), QwtColorMap::colorTable(), QwtScaleEngine::contains(), QwtLog10ScaleEngine::divideScale(), QwtLinearScaleEngine::divideScale(), QwtAlphaColorMap::rgb(), and QwtLinearColorMap::rgb().
 
271
.SS "void QwtDoubleInterval::setMinValue (double minValue)\fC [inline]\fP"
 
272
.PP
 
273
Assign the lower limit of the interval
 
274
.PP
 
275
\fBParameters:\fP
 
276
.RS 4
 
277
\fIminValue\fP Minimum value 
 
278
.RE
 
279
.PP
 
280
 
 
281
.PP
 
282
Definition at line 112 of file qwt_double_interval.h.
 
283
.PP
 
284
Referenced by QwtLinearScaleEngine::autoScale().
 
285
.SS "void QwtDoubleInterval::setMaxValue (double maxValue)\fC [inline]\fP"
 
286
.PP
 
287
Assign the upper limit of the interval
 
288
.PP
 
289
\fBParameters:\fP
 
290
.RS 4
 
291
\fImaxValue\fP Maximum value 
 
292
.RE
 
293
.PP
 
294
 
 
295
.PP
 
296
Definition at line 122 of file qwt_double_interval.h.
 
297
.PP
 
298
Referenced by QwtLinearScaleEngine::autoScale().
 
299
.SS "bool QwtDoubleInterval::contains (double value) const"
 
300
.PP
 
301
Test if a value is inside an interval
 
302
.PP
 
303
\fBParameters:\fP
 
304
.RS 4
 
305
\fIvalue\fP Value 
 
306
.RE
 
307
.PP
 
308
\fBReturns:\fP
 
309
.RS 4
 
310
true, if value >= \fBminValue()\fP && value <= \fBmaxValue()\fP 
 
311
.RE
 
312
.PP
 
313
 
 
314
.PP
 
315
Definition at line 54 of file qwt_double_interval.cpp.
 
316
.PP
 
317
References isValid().
 
318
.PP
 
319
Referenced by QwtRasterData::contourLines().
 
320
.SS "bool QwtDoubleInterval::intersects (const \fBQwtDoubleInterval\fP & interval) const"
 
321
.PP
 
322
Test if two intervals overlap 
 
323
.PP
 
324
Definition at line 119 of file qwt_double_interval.cpp.
 
325
.PP
 
326
References isValid(), maxValue(), and minValue().
 
327
.SS "\fBQwtDoubleInterval\fP QwtDoubleInterval::intersect (const \fBQwtDoubleInterval\fP &) const"
 
328
.PP
 
329
Intersect 2 intervals. 
 
330
.PP
 
331
Definition at line 83 of file qwt_double_interval.cpp.
 
332
.PP
 
333
References isValid(), maxValue(), minValue(), and QwtDoubleInterval().
 
334
.PP
 
335
Referenced by operator &().
 
336
.SS "\fBQwtDoubleInterval\fP QwtDoubleInterval::unite (const \fBQwtDoubleInterval\fP &) const"
 
337
.PP
 
338
Unite 2 intervals. 
 
339
.PP
 
340
Definition at line 63 of file qwt_double_interval.cpp.
 
341
.PP
 
342
References isValid(), maxValue(), minValue(), and QwtDoubleInterval().
 
343
.PP
 
344
Referenced by operator|().
 
345
.SS "\fBQwtDoubleInterval\fP QwtDoubleInterval::operator| (const \fBQwtDoubleInterval\fP & interval) const\fC [inline]\fP"
 
346
.PP
 
347
Union of two intervals 
 
348
.PP
 
349
\fBSee also:\fP
 
350
.RS 4
 
351
\fBunite\fP 
 
352
.RE
 
353
.PP
 
354
 
 
355
.PP
 
356
Definition at line 165 of file qwt_double_interval.h.
 
357
.PP
 
358
References unite().
 
359
.SS "\fBQwtDoubleInterval\fP QwtDoubleInterval::operator & (const \fBQwtDoubleInterval\fP & interval) const\fC [inline]\fP"
 
360
.PP
 
361
Intersection of two intervals 
 
362
.PP
 
363
\fBSee also:\fP
 
364
.RS 4
 
365
\fBintersect\fP 
 
366
.RE
 
367
.PP
 
368
 
 
369
.PP
 
370
Definition at line 155 of file qwt_double_interval.h.
 
371
.PP
 
372
References intersect().
 
373
.SS "\fBQwtDoubleInterval\fP QwtDoubleInterval::extend (double value) const"
 
374
.PP
 
375
Extend the interval
 
376
.PP
 
377
If value is below minValue, value becomes the lower limit. If value is above maxValue, value becomes the upper limit.
 
378
.PP
 
379
extend has no effect for invalid intervals
 
380
.PP
 
381
\fBParameters:\fP
 
382
.RS 4
 
383
\fIvalue\fP Value 
 
384
.RE
 
385
.PP
 
386
\fBSee also:\fP
 
387
.RS 4
 
388
\fBisValid\fP 
 
389
.RE
 
390
.PP
 
391
 
 
392
.PP
 
393
Definition at line 185 of file qwt_double_interval.cpp.
 
394
.PP
 
395
References isValid(), and QwtDoubleInterval().
 
396
.PP
 
397
Referenced by QwtLog10ScaleEngine::autoScale(), QwtLinearScaleEngine::autoScale(), and operator|().
 
398
.SS "\fBQwtDoubleInterval\fP QwtDoubleInterval::operator| (double value) const\fC [inline]\fP"
 
399
.PP
 
400
Extend an interval 
 
401
.PP
 
402
\fBSee also:\fP
 
403
.RS 4
 
404
\fBextend\fP 
 
405
.RE
 
406
.PP
 
407
 
 
408
.PP
 
409
Definition at line 188 of file qwt_double_interval.h.
 
410
.PP
 
411
References extend().
 
412
.SS "bool QwtDoubleInterval::isValid () const\fC [inline]\fP"
 
413
.PP
 
414
\fBReturns:\fP
 
415
.RS 4
 
416
true, if \fBminValue()\fP <= \fBmaxValue()\fP 
 
417
.RE
 
418
.PP
 
419
 
 
420
.PP
 
421
Definition at line 200 of file qwt_double_interval.h.
 
422
.PP
 
423
Referenced by QwtColorMap::colorTable(), QwtScaleEngine::contains(), contains(), QwtRasterData::contourLines(), extend(), intersect(), intersects(), limited(), normalized(), QwtScaleEngine::strip(), symmetrize(), unite(), QwtPlot::updateAxes(), and width().
 
424
.SS "bool QwtDoubleInterval::isNull () const\fC [inline]\fP"
 
425
.PP
 
426
\fBReturns:\fP
 
427
.RS 4
 
428
true, if \fBminValue()\fP >= \fBmaxValue()\fP 
 
429
.RE
 
430
.PP
 
431
 
 
432
.PP
 
433
Definition at line 194 of file qwt_double_interval.h.
 
434
.SS "void QwtDoubleInterval::invalidate ()\fC [inline]\fP"
 
435
.PP
 
436
Invalidate the interval
 
437
.PP
 
438
The limits are set to interval [0.0, -1.0] 
 
439
.PP
 
440
\fBSee also:\fP
 
441
.RS 4
 
442
\fBisValid\fP 
 
443
.RE
 
444
.PP
 
445
 
 
446
.PP
 
447
Definition at line 211 of file qwt_double_interval.h.
 
448
.SS "\fBQwtDoubleInterval\fP QwtDoubleInterval::symmetrize (double value) const"
 
449
.PP
 
450
Adjust the limit that is closer to value, so that value becomes the center of the interval.
 
451
.PP
 
452
\fBParameters:\fP
 
453
.RS 4
 
454
\fIvalue\fP Center 
 
455
.RE
 
456
.PP
 
457
\fBReturns:\fP
 
458
.RS 4
 
459
Interval with value as center 
 
460
.RE
 
461
.PP
 
462
 
 
463
.PP
 
464
Definition at line 140 of file qwt_double_interval.cpp.
 
465
.PP
 
466
References isValid(), and QwtDoubleInterval().
 
467
.PP
 
468
Referenced by QwtLinearScaleEngine::autoScale().
 
469
 
 
470
.SH "Author"
 
471
.PP 
 
472
Generated automatically by Doxygen for Qwt User's Guide from the source code.