Files
scylladb/range.hh

690 lines
28 KiB
C++

/*
* Copyright (C) 2015 ScyllaDB
*/
/*
* This file is part of Scylla.
*
* Scylla is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Scylla is distributed in the hope that it will be useful,
* but WITHOUT ANY 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 Scylla. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
#include "stdx.hh"
#include <list>
#include <experimental/optional>
#include <iosfwd>
#include <boost/range/algorithm/copy.hpp>
#include <boost/range/adaptor/sliced.hpp>
#include <boost/range/adaptor/transformed.hpp>
template<typename T>
class range_bound {
T _value;
bool _inclusive;
public:
range_bound(T value, bool inclusive = true)
: _value(std::move(value))
, _inclusive(inclusive)
{ }
const T& value() const & { return _value; }
T&& value() && { return std::move(_value); }
bool is_inclusive() const { return _inclusive; }
bool operator==(const range_bound& other) const {
return (_value == other._value) && (_inclusive == other._inclusive);
}
template<typename Comparator>
bool equal(const range_bound& other, Comparator&& cmp) const {
return _inclusive == other._inclusive && cmp(_value, other._value) == 0;
}
};
template<typename T>
class nonwrapping_range;
// A range which can have inclusive, exclusive or open-ended bounds on each end.
// The end bound can be smaller than the start bound.
template<typename T>
class wrapping_range {
template <typename U>
using optional = std::experimental::optional<U>;
public:
using bound = range_bound<T>;
private:
optional<bound> _start;
optional<bound> _end;
bool _singular;
public:
wrapping_range(optional<bound> start, optional<bound> end, bool singular = false)
: _start(std::move(start))
, _end(std::move(end))
, _singular(singular)
{ }
wrapping_range(T value)
: _start(bound(std::move(value), true))
, _end()
, _singular(true)
{ }
wrapping_range() : wrapping_range({}, {}) { }
private:
// Bound wrappers for compile-time dispatch and safety.
struct start_bound_ref { const optional<bound>& b; };
struct end_bound_ref { const optional<bound>& b; };
start_bound_ref start_bound() const { return { start() }; }
end_bound_ref end_bound() const { return { end() }; }
template<typename Comparator>
static bool greater_than_or_equal(end_bound_ref end, start_bound_ref start, Comparator&& cmp) {
return !end.b || !start.b || cmp(end.b->value(), start.b->value())
>= (!end.b->is_inclusive() || !start.b->is_inclusive());
}
template<typename Comparator>
static bool less_than(end_bound_ref end, start_bound_ref start, Comparator&& cmp) {
return !greater_than_or_equal(end, start, cmp);
}
template<typename Comparator>
static bool less_than_or_equal(start_bound_ref first, start_bound_ref second, Comparator&& cmp) {
return !first.b || (second.b && cmp(first.b->value(), second.b->value())
<= -(!first.b->is_inclusive() && second.b->is_inclusive()));
}
template<typename Comparator>
static bool less_than(start_bound_ref first, start_bound_ref second, Comparator&& cmp) {
return second.b && (!first.b || cmp(first.b->value(), second.b->value())
< (first.b->is_inclusive() && !second.b->is_inclusive()));
}
template<typename Comparator>
static bool greater_than_or_equal(end_bound_ref first, end_bound_ref second, Comparator&& cmp) {
return !first.b || (second.b && cmp(first.b->value(), second.b->value())
>= (!first.b->is_inclusive() && second.b->is_inclusive()));
}
public:
// the point is before the range (works only for non wrapped ranges)
// Comparator must define a total ordering on T.
template<typename Comparator>
bool before(const T& point, Comparator&& cmp) const {
assert(!is_wrap_around(cmp));
if (!start()) {
return false; //open start, no points before
}
auto r = cmp(point, start()->value());
if (r < 0) {
return true;
}
if (!start()->is_inclusive() && r == 0) {
return true;
}
return false;
}
// the point is after the range (works only for non wrapped ranges)
// Comparator must define a total ordering on T.
template<typename Comparator>
bool after(const T& point, Comparator&& cmp) const {
assert(!is_wrap_around(cmp));
if (!end()) {
return false; //open end, no points after
}
auto r = cmp(end()->value(), point);
if (r < 0) {
return true;
}
if (!end()->is_inclusive() && r == 0) {
return true;
}
return false;
}
// check if two ranges overlap.
// Comparator must define a total ordering on T.
template<typename Comparator>
bool overlaps(const wrapping_range& other, Comparator&& cmp) const {
bool this_wraps = is_wrap_around(cmp);
bool other_wraps = other.is_wrap_around(cmp);
if (this_wraps && other_wraps) {
return true;
} else if (this_wraps) {
auto unwrapped = unwrap();
return other.overlaps(unwrapped.first, cmp) || other.overlaps(unwrapped.second, cmp);
} else if (other_wraps) {
auto unwrapped = other.unwrap();
return overlaps(unwrapped.first, cmp) || overlaps(unwrapped.second, cmp);
}
// No range should reach this point as wrap around.
assert(!this_wraps);
assert(!other_wraps);
// if both this and other have an open start, the two ranges will overlap.
if (!start() && !other.start()) {
return true;
}
return greater_than_or_equal(end_bound(), other.start_bound(), cmp)
&& greater_than_or_equal(other.end_bound(), start_bound(), cmp);
}
static wrapping_range make(bound start, bound end) {
return wrapping_range({std::move(start)}, {std::move(end)});
}
static wrapping_range make_open_ended_both_sides() {
return {{}, {}};
}
static wrapping_range make_singular(T value) {
return {std::move(value)};
}
static wrapping_range make_starting_with(bound b) {
return {{std::move(b)}, {}};
}
static wrapping_range make_ending_with(bound b) {
return {{}, {std::move(b)}};
}
bool is_singular() const {
return _singular;
}
bool is_full() const {
return !_start && !_end;
}
void reverse() {
if (!_singular) {
std::swap(_start, _end);
}
}
const optional<bound>& start() const {
return _start;
}
const optional<bound>& end() const {
return _singular ? _start : _end;
}
// Range is a wrap around if end value is smaller than the start value
// or they're equal and at least one bound is not inclusive.
// Comparator must define a total ordering on T.
template<typename Comparator>
bool is_wrap_around(Comparator&& cmp) const {
if (_end && _start) {
auto r = cmp(end()->value(), start()->value());
return r < 0
|| (r == 0 && (!start()->is_inclusive() || !end()->is_inclusive()));
} else {
return false; // open ended range or singular range don't wrap around
}
}
// Converts a wrap-around range to two non-wrap-around ranges.
// The returned ranges are not overlapping and ordered.
// Call only when is_wrap_around().
std::pair<wrapping_range, wrapping_range> unwrap() const {
return {
{ {}, end() },
{ start(), {} }
};
}
// the point is inside the range
// Comparator must define a total ordering on T.
template<typename Comparator>
bool contains(const T& point, Comparator&& cmp) const {
if (is_wrap_around(cmp)) {
auto unwrapped = unwrap();
return unwrapped.first.contains(point, cmp)
|| unwrapped.second.contains(point, cmp);
} else {
return !before(point, cmp) && !after(point, cmp);
}
}
// Returns true iff all values contained by other are also contained by this.
// Comparator must define a total ordering on T.
template<typename Comparator>
bool contains(const wrapping_range& other, Comparator&& cmp) const {
bool this_wraps = is_wrap_around(cmp);
bool other_wraps = other.is_wrap_around(cmp);
if (this_wraps && other_wraps) {
return cmp(start()->value(), other.start()->value())
<= -(!start()->is_inclusive() && other.start()->is_inclusive())
&& cmp(end()->value(), other.end()->value())
>= (!end()->is_inclusive() && other.end()->is_inclusive());
}
if (!this_wraps && !other_wraps) {
return less_than_or_equal(start_bound(), other.start_bound(), cmp)
&& greater_than_or_equal(end_bound(), other.end_bound(), cmp);
}
if (other_wraps) { // && !this_wraps
return !start() && !end();
}
// !other_wraps && this_wraps
return (other.start() && cmp(start()->value(), other.start()->value())
<= -(!start()->is_inclusive() && other.start()->is_inclusive()))
|| (other.end() && cmp(end()->value(), other.end()->value())
>= (!end()->is_inclusive() && other.end()->is_inclusive()));
}
// Returns ranges which cover all values covered by this range but not covered by the other range.
// Ranges are not overlapping and ordered.
// Comparator must define a total ordering on T.
template<typename Comparator>
std::vector<wrapping_range> subtract(const wrapping_range& other, Comparator&& cmp) const {
std::vector<wrapping_range> result;
std::list<wrapping_range> left;
std::list<wrapping_range> right;
if (is_wrap_around(cmp)) {
auto u = unwrap();
left.emplace_back(std::move(u.first));
left.emplace_back(std::move(u.second));
} else {
left.push_back(*this);
}
if (other.is_wrap_around(cmp)) {
auto u = other.unwrap();
right.emplace_back(std::move(u.first));
right.emplace_back(std::move(u.second));
} else {
right.push_back(other);
}
// left and right contain now non-overlapping, ordered ranges
while (!left.empty() && !right.empty()) {
auto& r1 = left.front();
auto& r2 = right.front();
if (less_than(r2.end_bound(), r1.start_bound(), cmp)) {
right.pop_front();
} else if (less_than(r1.end_bound(), r2.start_bound(), cmp)) {
result.emplace_back(std::move(r1));
left.pop_front();
} else { // Overlap
auto tmp = std::move(r1);
left.pop_front();
if (!greater_than_or_equal(r2.end_bound(), tmp.end_bound(), cmp)) {
left.push_front({bound(r2.end()->value(), !r2.end()->is_inclusive()), tmp.end()});
}
if (!less_than_or_equal(r2.start_bound(), tmp.start_bound(), cmp)) {
left.push_front({tmp.start(), bound(r2.start()->value(), !r2.start()->is_inclusive())});
}
}
}
boost::copy(left, std::back_inserter(result));
// TODO: Merge adjacent ranges (optimization)
return result;
}
// split range in two around a split_point. split_point has to be inside the range
// split_point will belong to first range
// Comparator must define a total ordering on T.
template<typename Comparator>
std::pair<wrapping_range<T>, wrapping_range<T>> split(const T& split_point, Comparator&& cmp) const {
assert(contains(split_point, std::forward<Comparator>(cmp)));
wrapping_range left(start(), bound(split_point));
wrapping_range right(bound(split_point, false), end());
return std::make_pair(std::move(left), std::move(right));
}
// Create a sub-range including values greater than the split_point. Returns stdx::nullopt if
// split_point is after the end (but not included in the range, in case of wraparound ranges)
// Comparator must define a total ordering on T.
template<typename Comparator>
stdx::optional<wrapping_range<T>> split_after(const T& split_point, Comparator&& cmp) const {
if (contains(split_point, std::forward<Comparator>(cmp))
&& (!end() || cmp(split_point, end()->value()) != 0)) {
return wrapping_range(bound(split_point, false), end());
} else if (end() && cmp(split_point, end()->value()) >= 0) {
// whether to return stdx::nullopt or the full range is not
// well-defined for wraparound ranges; we return nullopt
// if split_point is after the end.
return stdx::nullopt;
} else {
return *this;
}
}
// Transforms this range into a new range of a different value type
// Supplied transformer should transform value of type T (the old type) into value of type U (the new type).
template<typename Transformer, typename U = typename std::result_of<Transformer(T)>::type>
wrapping_range<U> transform(Transformer&& transformer) && {
auto t = [&transformer] (std::experimental::optional<bound>&& b)
-> std::experimental::optional<typename wrapping_range<U>::bound>
{
if (!b) {
return {};
}
return { { transformer(std::move(*b).value()), b->is_inclusive() } };
};
return wrapping_range<U>(t(std::move(_start)), t(std::move(_end)), _singular);
}
template<typename Comparator>
bool equal(const wrapping_range& other, Comparator&& cmp) const {
return bool(_start) == bool(other._start)
&& bool(_end) == bool(other._end)
&& (!_start || _start->equal(*other._start, cmp))
&& (!_end || _end->equal(*other._end, cmp))
&& _singular == other._singular;
}
bool operator==(const wrapping_range& other) const {
return (_start == other._start) && (_end == other._end) && (_singular == other._singular);
}
template<typename U>
friend std::ostream& operator<<(std::ostream& out, const wrapping_range<U>& r);
private:
friend class nonwrapping_range<T>;
};
template<typename U>
std::ostream& operator<<(std::ostream& out, const wrapping_range<U>& r) {
if (r.is_singular()) {
return out << "==" << r.start()->value();
}
if (!r.start()) {
out << "(-inf, ";
} else {
if (r.start()->is_inclusive()) {
out << "[";
} else {
out << "(";
}
out << r.start()->value() << ", ";
}
if (!r.end()) {
out << "+inf)";
} else {
out << r.end()->value();
if (r.end()->is_inclusive()) {
out << "]";
} else {
out << ")";
}
}
return out;
}
// A range which can have inclusive, exclusive or open-ended bounds on each end.
// The end bound can never be smaller than the start bound.
template<typename T>
class nonwrapping_range {
template <typename U>
using optional = std::experimental::optional<U>;
public:
using bound = range_bound<T>;
private:
wrapping_range<T> _range;
public:
nonwrapping_range(T value)
: _range(std::move(value))
{ }
nonwrapping_range() : nonwrapping_range({}, {}) { }
// Can only be called if start <= end. IDL ctor.
nonwrapping_range(optional<bound> start, optional<bound> end, bool singular = false)
: _range(std::move(start), std::move(end), singular)
{ }
// Can only be called if !r.is_wrap_around().
explicit nonwrapping_range(wrapping_range<T>&& r)
: _range(std::move(r))
{ }
// Can only be called if !r.is_wrap_around().
explicit nonwrapping_range(const wrapping_range<T>& r)
: _range(r)
{ }
operator wrapping_range<T>() const & {
return _range;
}
operator wrapping_range<T>() && {
return std::move(_range);
}
// the point is before the range.
// Comparator must define a total ordering on T.
template<typename Comparator>
bool before(const T& point, Comparator&& cmp) const {
return _range.before(point, std::forward<Comparator>(cmp));
}
// the point is after the range.
// Comparator must define a total ordering on T.
template<typename Comparator>
bool after(const T& point, Comparator&& cmp) const {
return _range.after(point, std::forward<Comparator>(cmp));
}
// check if two ranges overlap.
// Comparator must define a total ordering on T.
template<typename Comparator>
bool overlaps(const nonwrapping_range& other, Comparator&& cmp) const {
// if both this and other have an open start, the two ranges will overlap.
if (!start() && !other.start()) {
return true;
}
return wrapping_range<T>::greater_than_or_equal(_range.end_bound(), other._range.start_bound(), cmp)
&& wrapping_range<T>::greater_than_or_equal(other._range.end_bound(), _range.start_bound(), cmp);
}
static nonwrapping_range make(bound start, bound end) {
return nonwrapping_range({std::move(start)}, {std::move(end)});
}
static nonwrapping_range make_open_ended_both_sides() {
return {{}, {}};
}
static nonwrapping_range make_singular(T value) {
return {std::move(value)};
}
static nonwrapping_range make_starting_with(bound b) {
return {{std::move(b)}, {}};
}
static nonwrapping_range make_ending_with(bound b) {
return {{}, {std::move(b)}};
}
bool is_singular() const {
return _range.is_singular();
}
bool is_full() const {
return _range.is_full();
}
const optional<bound>& start() const {
return _range.start();
}
const optional<bound>& end() const {
return _range.end();
}
// the point is inside the range
// Comparator must define a total ordering on T.
template<typename Comparator>
bool contains(const T& point, Comparator&& cmp) const {
return !before(point, cmp) && !after(point, cmp);
}
// Returns true iff all values contained by other are also contained by this.
// Comparator must define a total ordering on T.
template<typename Comparator>
bool contains(const nonwrapping_range& other, Comparator&& cmp) const {
return wrapping_range<T>::less_than_or_equal(_range.start_bound(), other._range.start_bound(), cmp)
&& wrapping_range<T>::greater_than_or_equal(_range.end_bound(), other._range.end_bound(), cmp);
}
// Returns ranges which cover all values covered by this range but not covered by the other range.
// Ranges are not overlapping and ordered.
// Comparator must define a total ordering on T.
template<typename Comparator>
std::vector<nonwrapping_range> subtract(const nonwrapping_range& other, Comparator&& cmp) const {
auto subtracted = _range.subtract(other._range, std::forward<Comparator>(cmp));
return boost::copy_range<std::vector<nonwrapping_range>>(subtracted | boost::adaptors::transformed([](auto&& r) {
return nonwrapping_range(std::move(r));
}));
}
// split range in two around a split_point. split_point has to be inside the range
// split_point will belong to first range
// Comparator must define a total ordering on T.
template<typename Comparator>
std::pair<nonwrapping_range<T>, nonwrapping_range<T>> split(const T& split_point, Comparator&& cmp) const {
assert(contains(split_point, std::forward<Comparator>(cmp)));
nonwrapping_range left(start(), bound(split_point));
nonwrapping_range right(bound(split_point, false), end());
return std::make_pair(std::move(left), std::move(right));
}
// Create a sub-range including values greater than the split_point. If split_point is after
// the end, returns stdx::nullopt.
template<typename Comparator>
stdx::optional<nonwrapping_range> split_after(const T& split_point, Comparator&& cmp) const {
if (end() && cmp(split_point, end()->value()) >= 0) {
return stdx::nullopt;
} else if (start() && cmp(split_point, start()->value()) < 0) {
return *this;
} else {
return nonwrapping_range(range_bound<T>(split_point, false), end());
}
}
// Transforms this range into a new range of a different value type
// Supplied transformer should transform value of type T (the old type) into value of type U (the new type).
template<typename Transformer, typename U = typename std::result_of<Transformer(T)>::type>
nonwrapping_range<U> transform(Transformer&& transformer) && {
return nonwrapping_range<U>(std::move(_range).transform(std::forward<Transformer>(transformer)));
}
template<typename Comparator>
bool equal(const nonwrapping_range& other, Comparator&& cmp) const {
return _range.equal(other._range, std::forward<Comparator>(cmp));
}
bool operator==(const nonwrapping_range& other) const {
return _range == other._range;
}
// Takes a vector of possibly overlapping ranges and returns a vector containing
// a set of non-overlapping ranges covering the same values.
template<typename Comparator>
static std::vector<nonwrapping_range> deoverlap(std::vector<nonwrapping_range> ranges, Comparator&& cmp) {
auto size = ranges.size();
if (size <= 1) {
return ranges;
}
std::sort(ranges.begin(), ranges.end(), [&](auto&& r1, auto&& r2) {
return wrapping_range<T>::less_than(r1._range.start_bound(), r2._range.start_bound(), cmp);
});
std::vector<nonwrapping_range> deoverlapped_ranges;
deoverlapped_ranges.reserve(size);
auto&& current = ranges[0];
for (auto&& r : ranges | boost::adaptors::sliced(1, ranges.size())) {
bool includes_end = wrapping_range<T>::greater_than_or_equal(r._range.end_bound(), current._range.start_bound(), cmp)
&& wrapping_range<T>::greater_than_or_equal(current._range.end_bound(), r._range.end_bound(), cmp);
if (includes_end) {
continue; // last.start <= r.start <= r.end <= last.end
}
bool includes_start = wrapping_range<T>::greater_than_or_equal(current._range.end_bound(), r._range.start_bound(), cmp);
if (includes_start) {
current = nonwrapping_range(std::move(current.start()), std::move(r.end()));
} else {
deoverlapped_ranges.emplace_back(std::move(current));
current = std::move(r);
}
}
deoverlapped_ranges.emplace_back(std::move(current));
return deoverlapped_ranges;
}
private:
// These private functions optimize the case where a sequence supports the
// lower and upper bound operations more efficiently, as is the case with
// some boost containers.
struct std_ {};
struct built_in_ : std_ {};
template<typename Range, typename LessComparator,
typename = decltype(&std::remove_reference<Range>::type::lower_bound)>
typename std::remove_reference<Range>::type::const_iterator do_lower_bound(const T& value, Range&& r, LessComparator&& cmp, built_in_) const {
return r.lower_bound(value, std::forward<LessComparator>(cmp));
}
template<typename Range, typename LessComparator,
typename = decltype(&std::remove_reference<Range>::type::upper_bound)>
typename std::remove_reference<Range>::type::const_iterator do_upper_bound(const T& value, Range&& r, LessComparator&& cmp, built_in_) const {
return r.upper_bound(value, std::forward<LessComparator>(cmp));
}
template<typename Range, typename LessComparator>
typename std::remove_reference<Range>::type::const_iterator do_lower_bound(const T& value, Range&& r, LessComparator&& cmp, std_) const {
return std::lower_bound(r.begin(), r.end(), value, std::forward<LessComparator>(cmp));
}
template<typename Range, typename LessComparator>
typename std::remove_reference<Range>::type::const_iterator do_upper_bound(const T& value, Range&& r, LessComparator&& cmp, std_) const {
return std::upper_bound(r.begin(), r.end(), value, std::forward<LessComparator>(cmp));
}
public:
// Return the lower bound of the specified sequence according to these bounds.
template<typename Range, typename LessComparator>
typename std::remove_reference<Range>::type::const_iterator lower_bound(Range&& r, LessComparator&& cmp) const {
return start()
? (start()->is_inclusive()
? do_lower_bound(start()->value(), std::forward<Range>(r), std::forward<LessComparator>(cmp), built_in_())
: do_upper_bound(start()->value(), std::forward<Range>(r), std::forward<LessComparator>(cmp), built_in_()))
: std::cbegin(r);
}
// Return the upper bound of the specified sequence according to these bounds.
template<typename Range, typename LessComparator>
typename std::remove_reference<Range>::type::const_iterator upper_bound(Range&& r, LessComparator&& cmp) const {
return end()
? (end()->is_inclusive()
? do_upper_bound(end()->value(), std::forward<Range>(r), std::forward<LessComparator>(cmp), built_in_())
: do_lower_bound(end()->value(), std::forward<Range>(r), std::forward<LessComparator>(cmp), built_in_()))
: (is_singular()
? do_upper_bound(start()->value(), std::forward<Range>(r), std::forward<LessComparator>(cmp), built_in_())
: std::cend(r));
}
// Returns a subset of the range that is within these bounds.
template<typename Range, typename LessComparator>
boost::iterator_range<typename std::remove_reference<Range>::type::const_iterator>
slice(Range&& range, LessComparator&& cmp) const {
return boost::make_iterator_range(lower_bound(range, cmp), upper_bound(range, cmp));
}
template<typename U>
friend std::ostream& operator<<(std::ostream& out, const nonwrapping_range<U>& r);
};
template<typename U>
std::ostream& operator<<(std::ostream& out, const nonwrapping_range<U>& r) {
return out << r._range;
}
template<typename T>
using range = wrapping_range<T>;
// Allow using range<T> in a hash table. The hash function 31 * left +
// right is the same one used by Cassandra's AbstractBounds.hashCode().
namespace std {
template<typename T>
struct hash<wrapping_range<T>> {
using argument_type = wrapping_range<T>;
using result_type = decltype(std::hash<T>()(std::declval<T>()));
result_type operator()(argument_type const& s) const {
auto hash = std::hash<T>();
auto left = s.start() ? hash(s.start()->value()) : 0;
auto right = s.end() ? hash(s.end()->value()) : 0;
return 31 * left + right;
}
};
template<typename T>
struct hash<nonwrapping_range<T>> {
using argument_type = nonwrapping_range<T>;
using result_type = decltype(std::hash<T>()(std::declval<T>()));
result_type operator()(argument_type const& s) const {
return hash<wrapping_range<T>>()(s);
}
};
}