1
/* -*- mode: C++; c-basic-offset: 4; indent-tabs-mode: nil -*- */
2
// vim: ft=cpp:expandtab:ts=8:sw=4:softtabstop=4:
5
COPYING CONDITIONS NOTICE:
7
This program is free software; you can redistribute it and/or modify
8
it under the terms of version 2 of the GNU General Public License as
9
published by the Free Software Foundation, and provided that the
10
following conditions are met:
12
* Redistributions of source code must retain this COPYING
13
CONDITIONS NOTICE, the COPYRIGHT NOTICE (below), the
14
DISCLAIMER (below), the UNIVERSITY PATENT NOTICE (below), the
15
PATENT MARKING NOTICE (below), and the PATENT RIGHTS
18
* Redistributions in binary form must reproduce this COPYING
19
CONDITIONS NOTICE, the COPYRIGHT NOTICE (below), the
20
DISCLAIMER (below), the UNIVERSITY PATENT NOTICE (below), the
21
PATENT MARKING NOTICE (below), and the PATENT RIGHTS
22
GRANT (below) in the documentation and/or other materials
23
provided with the distribution.
25
You should have received a copy of the GNU General Public License
26
along with this program; if not, write to the Free Software
27
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
32
TokuDB, Tokutek Fractal Tree Indexing Library.
33
Copyright (C) 2007-2013 Tokutek, Inc.
37
This program is distributed in the hope that it will be useful, but
38
WITHOUT ANY WARRANTY; without even the implied warranty of
39
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
40
General Public License for more details.
42
UNIVERSITY PATENT NOTICE:
44
The technology is licensed by the Massachusetts Institute of
45
Technology, Rutgers State University of New Jersey, and the Research
46
Foundation of State University of New York at Stony Brook under
47
United States of America Serial No. 11/760379 and to the patents
48
and/or patent applications resulting from it.
50
PATENT MARKING NOTICE:
52
This software is covered by US Patent No. 8,185,551.
53
This software is covered by US Patent No. 8,489,638.
57
"THIS IMPLEMENTATION" means the copyrightable works distributed by
58
Tokutek as part of the Fractal Tree project.
60
"PATENT CLAIMS" means the claims of patents that are owned or
61
licensable by Tokutek, both currently or in the future; and that in
62
the absence of this license would be infringed by THIS
63
IMPLEMENTATION or by using or running THIS IMPLEMENTATION.
65
"PATENT CHALLENGE" shall mean a challenge to the validity,
66
patentability, enforceability and/or non-infringement of any of the
67
PATENT CLAIMS or otherwise opposing any of the PATENT CLAIMS.
69
Tokutek hereby grants to you, for the term and geographical scope of
70
the PATENT CLAIMS, a non-exclusive, no-charge, royalty-free,
71
irrevocable (except as stated in this section) patent license to
72
make, have made, use, offer to sell, sell, import, transfer, and
73
otherwise run, modify, and propagate the contents of THIS
74
IMPLEMENTATION, where such license applies only to the PATENT
75
CLAIMS. This grant does not include claims that would be infringed
76
only as a consequence of further modifications of THIS
77
IMPLEMENTATION. If you or your agent or licensee institute or order
78
or agree to the institution of patent litigation against any entity
79
(including a cross-claim or counterclaim in a lawsuit) alleging that
80
THIS IMPLEMENTATION constitutes direct or contributory patent
81
infringement, or inducement of patent infringement, then any rights
82
granted to you under this License shall terminate as of the date
83
such litigation is filed. If you or your agent or exclusive
84
licensee institute or order or agree to the institution of a PATENT
85
CHALLENGE, then Tokutek may terminate any rights granted to you
89
#ident "Copyright (c) 2007-2013 Tokutek Inc. All rights reserved."
90
#ident "The technology is licensed by the Massachusetts Institute of Technology, Rutgers State University of New Jersey, and the Research Foundation of State University of New York at Stony Brook under United States of America Serial No. 11/760379 and to the patents and/or patent applications resulting from it."
95
#include <ft/comparator.h>
99
// A keyrange has a left and right key as endpoints.
101
// When a keyrange is created it owns no memory, but when it copies
102
// or extends another keyrange, it copies memory as necessary. This
103
// means it is cheap in the common case.
108
// effect: constructor that borrows left and right key pointers.
109
// no memory is allocated or copied.
110
void create(const DBT *left_key, const DBT *right_key);
112
// effect: constructor that allocates and copies another keyrange's points.
113
void create_copy(const keyrange &range);
115
// effect: destroys the keyrange, freeing any allocated memory
118
// effect: extends the keyrange by choosing the leftmost and rightmost
119
// endpoints from this range and the given range.
120
// replaced keys in this range are freed, new keys are copied.
121
void extend(comparator *cmp, const keyrange &range);
123
// returns: the amount of memory this keyrange takes. does not account
124
// for point optimizations or malloc overhead.
125
uint64_t get_memory_size(void) const;
127
// returns: pointer to the left key of this range
128
const DBT *get_left_key(void) const;
130
// returns: pointer to the right key of this range
131
const DBT *get_right_key(void) const;
133
// two ranges are either equal, lt, gt, or overlapping
141
// effect: compares this range to the given range
142
// returns: LESS_THAN if given range is strictly to the left
143
// GREATER_THAN if given range is strictly to the right
144
// EQUALS if given range has the same left and right endpoints
145
// OVERLAPS if at least one of the given range's endpoints falls
146
// between this range's endpoints
147
comparison compare(comparator *cmp, const keyrange &range) const;
149
// returns: true if the range and the given range are equal or overlapping
150
bool overlaps(comparator *cmp, const keyrange &range) const;
152
// returns: a keyrange representing -inf, +inf
153
static keyrange get_infinite_range(void);
156
// some keys should be copied, some keys should not be.
158
// to support both, we use two DBTs for copies and two pointers
159
// for temporaries. the access rule is:
160
// - if a pointer is non-null, then it reprsents the key.
161
// - otherwise the pointer is null, and the key is in the copy.
163
DBT m_right_key_copy;
164
const DBT *m_left_key;
165
const DBT *m_right_key;
167
// if this range is a point range, then m_left_key == m_right_key
168
// and the actual data is stored exactly once in m_left_key_copy.
171
// effect: initializes a keyrange to be empty
172
void init_empty(void);
174
// effect: copies the given key once into the left key copy
175
// and sets the right key copy to share the left.
176
// rationale: optimization for point ranges to only do one malloc
177
void set_both_keys(const DBT *key);
179
// effect: destroys the current left key. sets and copies the new one.
180
void replace_left_key(const DBT *key);
182
// effect: destroys the current right key. sets and copies the new one.
183
void replace_right_key(const DBT *key);
186
} /* namespace toku */
188
#endif /* KEYRANGE_H */