PLearn 0.1
PRange.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // PRange.h
00004 //
00005 // Copyright (C) 2004-2005 ApSTAT Technologies Inc.
00006 // 
00007 // Redistribution and use in source and binary forms, with or without
00008 // modification, are permitted provided that the following conditions are met:
00009 // 
00010 //  1. Redistributions of source code must retain the above copyright
00011 //     notice, this list of conditions and the following disclaimer.
00012 // 
00013 //  2. Redistributions in binary form must reproduce the above copyright
00014 //     notice, this list of conditions and the following disclaimer in the
00015 //     documentation and/or other materials provided with the distribution.
00016 // 
00017 //  3. The name of the authors may not be used to endorse or promote
00018 //     products derived from this software without specific prior written
00019 //     permission.
00020 // 
00021 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00022 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00023 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00024 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00025 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00026 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00027 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00028 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00029 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00030 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00031 // 
00032 // This file is part of the PLearn library. For more information on the PLearn
00033 // library, go to the PLearn Web site at www.plearn.org
00034 
00035 /* *******************************************************      
00036  * $Id: PRange.h 9192 2008-07-02 16:48:44Z nouiz $ 
00037  ******************************************************* */
00038 
00039 // Authors: Jean-Sébastien Senécal
00040 
00043 #ifndef PRange_H
00044 #define PRange_H
00045 
00046 namespace PLearn {
00047 
00056 template<class T>
00057 class PRange
00058 {
00059 private:
00060     // Lower bound.
00061     T lower_;
00062 
00063     // Upper bound.
00064     T upper_;
00065 
00066 public:
00068     PRange() : lower_(0), upper_(-1) { }
00069 
00071     PRange(const T& val) : lower_(val), upper_(val) { }
00072 
00074     PRange(const T& lower, const T& upper)
00075     { setBounds(lower,upper); }
00076 
00078     bool contains(const T& val) const
00079     { return (lower_ <= val && val <= upper_); }
00080 
00082     bool isEmpty() const { return (lower_ > upper_); }
00083 
00085     T lower() const { return lower_; }
00086 
00088     T upper() const { return upper_; }
00089 
00090 
00092     void clear() { lower_ = 0; upper_ = -1; }
00093 
00095     void setValue(const T& val) { lower_ = upper_ = val; }
00096 
00098     void setBounds(const T& lower, const T& upper)
00099     {
00100         if (lower > upper)
00101         { lower_ = 0; upper_ = -1; }
00102         else
00103         { lower_ = lower; upper_ = upper; }
00104     }
00105 
00107     void translate(const T& offset)
00108     {
00109         lower_ += offset;
00110         upper_ += offset;
00111     }
00112 
00114     void translateUpper(const T& offset) { upper_ += offset; }
00115 
00117     void translateLower(const T& offset) { lower_ += offset; }
00118 
00120     T distance() const { return (max(0,upper_ - lower_ + 1)); }
00121 
00123     bool operator==(const PRange<T>& r)
00124     { return (r.lower() == lower_ && r.upper() == upper_); }
00125 
00127     bool operator!=(const PRange<T>& r) const
00128     { return (r.lower() != lower_ || r.upper() != upper_); }
00129 
00131     PRange& operator|=(const PRange<T>& r)
00132     {
00133         if (isEmpty())
00134             return operator=(r);
00135         else if (!r.isEmpty())
00136         {
00137             lower_ = min(lower_, r.lower());
00138             upper_ = max(upper_, r.upper());
00139         }
00140         return (*this);
00141     }
00142 
00144     PRange& operator&=(const PRange<T>& r)
00145     {
00146         if (! isEmpty()){
00147             if (! r.isEmpty()) {
00148                 lower_ = max(lower_, r.lower());
00149                 upper_ = min(upper_, r.upper());
00150             }
00151             else
00152                 clear();
00153         }
00154             
00155         return (*this);
00156     }
00157   
00158 };
00159 
00161 template<class T>
00162 PRange<T> operator|(const PRange<T>& r1, const PRange<T>& r2)
00163 {
00164     if (r1.isEmpty())
00165         return r2;
00166     else if (r2.isEmpty())
00167         return r1;
00168     else
00169         return PRange<T>( min(r1.lower(), r2.lower()), max(r1.upper(), r2.upper()) );
00170 }
00171 
00173 template<class T>
00174 PRange<T> operator&(const PRange<T>& r1, const PRange<T>& r2)
00175 {
00176     if ( r1.isEmpty() || r2.isEmpty() )
00177         return PRange<T>();                      // empty range
00178     else
00179         return PRange<T>( max(r1.lower(), r2.lower()), min(r1.upper(), r2.upper()) );
00180 }
00181   
00182 }
00183 
00184 #endif
00185 
00186 
00187 /*
00188   Local Variables:
00189   mode:c++
00190   c-basic-offset:4
00191   c-file-style:"stroustrup"
00192   c-file-offsets:((innamespace . 0)(inline-open . 0))
00193   indent-tabs-mode:nil
00194   fill-column:79
00195   End:
00196 */
00197 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines