libDwm-0.6.0
DwmValueRange.hh
Go to the documentation of this file.
1 //===========================================================================
2 // @(#) $DwmPath: dwm/libDwm/tags/libDwm-0.6.0/include/DwmValueRange.hh 8401 $
3 // @(#) $Id: DwmValueRange.hh 8401 2016-04-17 06:44:31Z dwm $
4 //===========================================================================
5 // Copyright (c) Daniel W. McRobb 2007
6 // All rights reserved.
7 //
8 // Redistribution and use in source and binary forms, with or without
9 // modification, are permitted provided that the following conditions
10 // are met:
11 //
12 // 1. Redistributions of source code must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 // 2. Redistributions in binary form must reproduce the above copyright
15 // notice, this list of conditions and the following disclaimer in the
16 // documentation and/or other materials provided with the distribution.
17 // 3. The names of the authors and copyright holders may not be used to
18 // endorse or promote products derived from this software without
19 // specific prior written permission.
20 //
21 // IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
22 // DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
23 // INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
24 // EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
25 // DAMAGE.
26 //
27 // THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
28 // DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
29 // UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
30 // REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER
31 // IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
32 // WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
33 // OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY PATENT,
34 // TRADEMARK OR OTHER RIGHTS.
35 //===========================================================================
36 
37 //---------------------------------------------------------------------------
40 //---------------------------------------------------------------------------
41 
42 #ifndef _DWMVALUERANGE_HH_
43 #define _DWMVALUERANGE_HH_
44 
45 #include <cassert>
46 #include <utility>
47 
48 namespace Dwm {
49 
50  //--------------------------------------------------------------------------
52  //--------------------------------------------------------------------------
53  template <typename T>
54  class ValueRange
55  : public std::pair<T,T>
56  {
57  public:
58  //------------------------------------------------------------------------
60  //------------------------------------------------------------------------
62  : std::pair<T,T>()
63  { }
64 
65  //------------------------------------------------------------------------
67  //------------------------------------------------------------------------
68  ValueRange(const T & low, const T & high)
69  : std::pair<T,T>(low, high)
70  {
71  assert(high >= low);
72  }
73 
74  //------------------------------------------------------------------------
76  //------------------------------------------------------------------------
77  bool Contains(const T & value) const
78  {
79  return((value >= this->first) && (value <= this->second));
80  }
81 
82  //------------------------------------------------------------------------
84  //------------------------------------------------------------------------
85  bool Contains(const ValueRange<T> & range) const
86  {
87  return(Contains(range.first) && Contains(range.second));
88  }
89 
90  //------------------------------------------------------------------------
92  //------------------------------------------------------------------------
93  bool Overlaps(const ValueRange<T> & range) const
94  {
95  return(this->Contains(range.first)
96  || this->Contains(range.second)
97  || range.Contains(this->first)
98  || range.Contains(this->second));
99  }
100 
101  };
102 
103 
104 } // namespace Dwm
105 
106 #endif // _DWMVALUERANGE_HH_
107 
108 //---------------------------- emacs settings -----------------------------
109 // Local Variables:
110 // mode: C++/la
111 // tab-width: 2
112 // indent-tabs-mode: nil
113 // c-basic-offset: 2
114 // End:
115 //-------------------------------------------------------------------------
bool Contains(const T &value) const
Returns true if the range contains value.
Definition: DwmValueRange.hh:77
This template encapsulates a range of values (low, high).
Definition: DwmValueRange.hh:54
STL namespace.
bool Overlaps(const ValueRange< T > &range) const
Returns true if the range overlaps the given range.
Definition: DwmValueRange.hh:93
Definition: DwmBZ2IO.hh:67
ValueRange()
Constructor.
Definition: DwmValueRange.hh:61
ValueRange(const T &low, const T &high)
Construct from given low and @ high values.
Definition: DwmValueRange.hh:68
bool Contains(const ValueRange< T > &range) const
Returns true if the range contains the given range.
Definition: DwmValueRange.hh:85