libcruft-util/range.hpp

99 lines
2.9 KiB
C++
Raw Normal View History

2011-05-23 17:18:52 +10:00
/*
* This file is part of libgim.
2011-05-23 17:18:52 +10:00
*
* libgim is free software: you can redistribute it and/or modify it under the
2011-05-23 17:18:52 +10:00
* terms of the GNU General Public License as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later
* version.
*
* libgim is distributed in the hope that it will be useful, but WITHOUT ANY
2011-05-23 17:18:52 +10:00
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with libgim. If not, see <http://www.gnu.org/licenses/>.
2011-05-23 17:18:52 +10:00
*
* Copyright 2010-2015 Danny Robson <danny@nerdcruft.net>
2011-05-23 17:18:52 +10:00
*/
#ifndef __UTIL_RANGE_HPP
#define __UTIL_RANGE_HPP
#include <iostream>
2011-05-23 17:18:52 +10:00
2011-08-15 20:11:42 +10:00
namespace util {
/**
* Represents a continuous range of values. Contains convenience functions
* and debugging checks.
*/
template <typename T>
struct range {
T min;
T max;
range (T _min, T _max);
/// Check whether value falls within this range (inclusive)
bool contains (T val) const;
/// Check whether a range falls completely within (inclusive) this range
bool contains (const range <T> &r) const;
/// Check whether a range falls partially within (inclusive) this range
//bool includes (const range <T> &r) const;
/// Return the closest number that falls within the range.
T clamp (T val) const;
2012-05-22 14:12:06 +10:00
/// Expand the range to include this value if necessary
2012-05-23 17:01:54 +10:00
void expand (T val);
2012-05-24 15:03:26 +10:00
/// Normalise a number to [0, 1] within the range. Does not check
/// bounds, it is the caller's responsibility to clamp the result if
/// needed.
template <typename U>
U normalise (T val) const;
2011-08-15 20:11:42 +10:00
2012-05-24 15:03:26 +10:00
range& operator*= (T);
range operator* (T) const;
range& operator/= (T);
range operator/ (T) const;
range& operator+= (T);
range operator+ (T) const;
range& operator-= (T);
range operator- (T) const;
2011-08-15 20:11:42 +10:00
/// Return a pseudo-random uniformly distributed value within the range.
/// There are no statistical randomness guarantees whatsoever.
T random (void) const;
2011-08-15 20:11:42 +10:00
bool operator ==(const range<T>& rhs) const;
bool operator !=(const range<T>& rhs) const
{ return !(*this == rhs); }
/// A range which is guaranteed to contain all elements type T
2012-06-15 16:38:10 +10:00
static const range<T> UNLIMITED;
static const range<T> MAX;
2011-08-15 20:11:42 +10:00
/// A range which only contains elements between 0 and 1 inclusive
2012-06-15 16:38:10 +10:00
static const range<T> UNIT;
2011-08-15 20:11:42 +10:00
void sanity (void) const;
};
template <typename T>
std::ostream&
operator <<(std::ostream &os, const range<T> &rhs) {
os << '[' << rhs.min << ", " << rhs.max << ']';
return os;
}
2011-05-23 17:18:52 +10:00
}
#include "range.ipp"
2011-05-23 17:18:52 +10:00
#endif