blob: a0df3f1008d476df88ba8fee560c467110c819dc (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/***************************************************************************
krange.h - description
-------------------
begin : Sun 03.08.2003
copyright : (C) 2003 by Friedrich W. H. Kossebau
email : [email protected]
****************************************************************************/
/***************************************************************************
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Library General Public *
* License version 2 as published by the Free Software Foundation. *
* *
***************************************************************************/
#ifndef KHE_KRANGE_H
#define KHE_KRANGE_H
namespace KHE
{
/** This template describes a range.
* A range is something with a start and an end.
* The start is a value relative before the end.
* The distance cannot be estimated.
*
*@author Friedrich W. H. Kossebau
*/
template<class T>
class KRange
{
public:
KRange( T S, T E ) : Start( S ), End( E ) {}
KRange() : Start( null() ), End( null() ) {}
~KRange() {}
public:
KRange &operator=( const KRange &R ) { Start = R.Start; End = R.End; return *this; }
public:
bool operator==( const KRange &R ) const { return Start == R.Start && End == R.End; }
public: // modification access
/** sets the first and the last index of the range */
void set( T S, T E ) { Start = S; End = E; }
/** sets the first index of the range */
void setStart( T S ) { Start = S; }
/** sets the last index of the range */
void setEnd( T E ) { End = E; }
/** sets the range to null */
void unset() { Start = End = null(); }
/** restricts the range to Limit. If one of both ranges is invalid the behaviour is undefined */
void restrictTo( const KRange &Limit )
{ if( Start < Limit.start() ) Start = Limit.start(); if( End > Limit.end() ) End = Limit.end(); }
/** restricts the start to Limit. If the range is invalid the behaviour is undefined */
void restrictStartTo( T Limit ) { if( Start < Limit ) Start = Limit; }
/** restricts the end to Limit. If the range is invalid the behaviour is undefined */
void restrictEndTo( T Limit ) { if( End > Limit ) End = Limit; }
/** extends the range to Limit. If one of both is invalid the behaviour is undefined */
void extendTo( const KRange &Limit )
{ if( Start > Limit.start() ) Start = Limit.start(); if( End < Limit.end() ) End = Limit.end(); }
/** extends the start to Limit. If the range is invalid the behaviour is undefined */
void extendStartTo( T Limit ) { if( Start > Limit ) Start = Limit; }
/** extends the end to Limit. If the range is invalid the behaviour is undefined */
void extendEndTo( T Limit ) { if( End < Limit ) End = Limit; }
/** moves the range by D. If the range is invalid the behaviour is undefined */
void moveBy( T D ) { Start += D; End += D; }
public: // value access
/** @return start */
T start() const { return Start; }
/** @return end */
T end() const { return End; }
public: // logic access
/** returns true if Value is covered */
bool includes( T Value ) const { return Value <= End && Value >= Start; }
/** returns true if range is before index. if range is invalid the behaviour is undefined */
bool endsBefore( T Value ) const { return End < Value; }
/** returns true if range is behind index. if range is invalid the behaviour is undefined */
bool startsBehind( T Value ) const { return Start > Value; }
/** returns true is the range starts before index. If the range is invalid the behaviour is undefined */
bool startsBefore( T Value ) const { return Start < Value; }
/** returns true is the range end later then index. If the range is invalid the behaviour is undefined */
bool endsBehind( T Value ) const { return End > Value; }
/** returns true is the range covers R. If one of both is invalid the behaviour is undefined */
bool includes( const KRange &R ) const { return End >= R.End && Start <= R.Start; }
/** returns true is the range ends before R starts. If one of both is invalid the behaviour is undefined */
bool endsBefore( const KRange &R ) const { return End < R.Start; }
/** returns true is the range starts later than R ends. If one of both is invalid the behaviour is undefined */
bool startsBehind( const KRange &R ) const { return Start > R.End; }
/** returns true is the range starts prior than R. If one of both is invalid the behaviour is undefined */
bool startsBefore( const KRange &R ) const { return Start < R.Start; }
/** returns true is the range ends later than R. If one of both is invalid the behaviour is undefined */
bool endsBehind( const KRange &R ) const { return End > R.End; }
/** returns true is the range shares at least one index with R. If one of both is invalid the behaviour is undefined */
bool overlaps( const KRange &R ) const { return Start <= R.End && End >= R.Start; }
/** returns true if the range covers at least one index */
bool isValid() const { return Start != null() && Start <= End; }
/** returns true if the range has not been set */
bool isEmpty() const { return Start == null() && End == null(); }
protected:
/** delivers a null element. Should be specialiced for complexer types. */
const T null () const { return T(-1);}
protected:
/** first value of the range */
T Start;
/** last value of the range */
T End;
};
}
#endif
|
