/usr/include/geos/index/strtree/AbstractSTRtree.h is in libgeos-dev 3.2.2-3ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 | /**********************************************************************
* $Id: AbstractSTRtree.h 2685 2009-10-20 16:59:30Z strk $
*
* GEOS - Geometry Engine Open Source
* http://geos.refractions.net
*
* Copyright (C) 2006 Refractions Research Inc.
*
* This is free software; you can redistribute and/or modify it under
* the terms of the GNU Lesser General Public Licence as published
* by the Free Software Foundation.
* See the COPYING file for more information.
*
**********************************************************************/
#ifndef GEOS_INDEX_STRTREE_ABSTRACTSTRTREE_H
#define GEOS_INDEX_STRTREE_ABSTRACTSTRTREE_H
#include <geos/export.h>
#include <geos/index/strtree/AbstractNode.h> // for inlines
#include <vector>
#include <list>
#include <memory> // for auto_ptr
#include <cassert> // for inlines
#include <algorithm>
// Forward declarations
namespace geos {
namespace index {
class ItemVisitor;
namespace strtree {
class Boundable;
class AbstractNode;
}
}
}
namespace geos {
namespace index { // geos::index
namespace strtree { // geos::index::strtree
/// A list of boundables. TODO: use a list
typedef std::vector<Boundable*> BoundableList;
//typedef std::list<Boundable*> BoundableList;
/// list contains boundables or lists of boundables. The lists are owned by
/// this class, the plain boundables are held by reference only.
class ItemsList;
class ItemsListItem
{
public:
enum type {
item_is_geometry,
item_is_list
};
ItemsListItem(void *item_)
: t(item_is_geometry)
{
item.g = item_;
}
ItemsListItem(ItemsList* item_)
: t(item_is_list)
{
item.l = item_;
}
type get_type() const { return t; }
void* get_geometry() const
{
assert(t == item_is_geometry);
return item.g;
}
ItemsList* get_itemslist() const
{
assert(t == item_is_list);
return item.l;
}
type t;
union {
void* g;
ItemsList* l;
} item;
};
class ItemsList : public std::vector<ItemsListItem>
{
private:
typedef std::vector<ItemsListItem> base_type;
static void delete_item(ItemsListItem& item)
{
if (ItemsListItem::item_is_list == item.t)
delete reinterpret_cast<ItemsList*>(item.item.l);
}
public:
~ItemsList()
{
std::for_each(begin(), end(), &ItemsList::delete_item);
}
// lists of items need to be deleted in the end
void push_back(void* item)
{
this->base_type::push_back(ItemsListItem(item));
}
// lists of items need to be deleted in the end
void push_back_owned(ItemsList* itemList)
{
this->base_type::push_back(ItemsListItem(itemList));
}
};
/** \brief
* Base class for STRtree and SIRtree.
*
* STR-packed R-trees are described in:
* P. Rigaux, Michel Scholl and Agnes Voisard. Spatial Databases With
* Application To GIS. Morgan Kaufmann, San Francisco, 2002.
*
* This implementation is based on Boundables rather than just AbstractNodes,
* because the STR algorithm operates on both nodes and
* data, both of which are treated here as Boundables.
*
*/
class GEOS_DLL AbstractSTRtree {
private:
bool built;
BoundableList* itemBoundables;
/**
* Creates the levels higher than the given level
*
* @param boundablesOfALevel
* the level to build on
* @param level
* the level of the Boundables, or -1 if the boundables are item
* boundables (that is, below level 0)
* @return the root, which may be a ParentNode or a LeafNode
*/
virtual AbstractNode* createHigherLevels(
BoundableList* boundablesOfALevel,
int level);
virtual std::auto_ptr<BoundableList> sortBoundables(const BoundableList* input)=0;
bool remove(const void* searchBounds, AbstractNode& node, void* item);
bool removeItem(AbstractNode& node, void* item);
ItemsList* itemsTree(AbstractNode* node);
protected:
/** \brief
* A test for intersection between two bounds, necessary because
* subclasses of AbstractSTRtree have different implementations of
* bounds.
*/
class IntersectsOp {
public:
/**
* For STRtrees, the bounds will be Envelopes; for
* SIRtrees, Intervals; for other subclasses of
* AbstractSTRtree, some other class.
* @param aBounds the bounds of one spatial object
* @param bBounds the bounds of another spatial object
* @return whether the two bounds intersect
*/
virtual bool intersects(const void* aBounds,
const void* bBounds)=0;
virtual ~IntersectsOp() {}
};
AbstractNode *root;
std::vector <AbstractNode *> *nodes;
// Ownership to caller (TODO: return by auto_ptr)
virtual AbstractNode* createNode(int level)=0;
/**
* Sorts the childBoundables then divides them into groups of size M, where
* M is the node capacity.
*/
virtual std::auto_ptr<BoundableList> createParentBoundables(
BoundableList* childBoundables, int newLevel);
virtual AbstractNode* lastNode(BoundableList* nodes)
{
assert(!nodes->empty());
// Cast from Boundable to AbstractNode
return static_cast<AbstractNode*>( nodes->back() );
}
virtual AbstractNode* getRoot() {
assert(built);
return root;
}
/// Also builds the tree, if necessary.
virtual void insert(const void* bounds,void* item);
/// Also builds the tree, if necessary.
void query(const void* searchBounds, std::vector<void*>& foundItems);
#if 0
/// Also builds the tree, if necessary.
std::vector<void*>* query(const void* searchBounds) {
vector<void*>* matches = new vector<void*>();
query(searchBounds, *matches);
return matches;
}
#endif
/// Also builds the tree, if necessary.
void query(const void* searchBounds, ItemVisitor& visitor);
void query(const void* searchBounds, const AbstractNode& node, ItemVisitor& visitor);
/// Also builds the tree, if necessary.
bool remove(const void* itemEnv, void* item);
std::auto_ptr<BoundableList> boundablesAtLevel(int level);
// @@ should be size_t, probably
size_t nodeCapacity;
/**
* @return a test for intersection between two bounds,
* necessary because subclasses
* of AbstractSTRtree have different implementations of bounds.
* @see IntersectsOp
*/
virtual IntersectsOp *getIntersectsOp()=0;
public:
/**
* Constructs an AbstractSTRtree with the specified maximum number of child
* nodes that a node may have
*/
AbstractSTRtree(size_t newNodeCapacity)
:
built(false),
itemBoundables(new BoundableList()),
nodes(new std::vector<AbstractNode *>()),
nodeCapacity(newNodeCapacity)
{
assert(newNodeCapacity>1);
}
static bool compareDoubles(double a, double b) {
// NOTE - strk:
// Ternary operation is a workaround for
// a probable MingW bug, see
// http://trac.osgeo.org/geos/ticket/293
return ( a < b ) ? true : false;
}
virtual ~AbstractSTRtree();
/**
* Creates parent nodes, grandparent nodes, and so forth up to the root
* node, for the data that has been inserted into the tree. Can only be
* called once, and thus can be called only after all of the data has been
* inserted into the tree.
*/
virtual void build();
/**
* Returns the maximum number of child nodes that a node may have
*/
virtual size_t getNodeCapacity() { return nodeCapacity; }
virtual void query(const void* searchBounds, const AbstractNode* node, std::vector<void*>* matches);
/**
* Iterate over all items added thus far. Explicitly does not build
* the tree.
*/
void iterate(ItemVisitor& visitor);
/**
* @param level -1 to get items
*/
virtual void boundablesAtLevel(int level, AbstractNode* top,
BoundableList* boundables);
/**
* Gets a tree structure (as a nested list)
* corresponding to the structure of the items and nodes in this tree.
* <p>
* The returned {@link List}s contain either {@link Object} items,
* or Lists which correspond to subtrees of the tree
* Subtrees which do not contain any items are not included.
* <p>
* Builds the tree if necessary.
*
* @note The caller is responsible for releasing the list
*
* @return a List of items and/or Lists
*/
ItemsList* itemsTree();
};
} // namespace geos::index::strtree
} // namespace geos::index
} // namespace geos
#endif // GEOS_INDEX_STRTREE_ABSTRACTSTRTREE_H
/**********************************************************************
* $Log$
* Revision 1.3 2006/06/12 10:49:43 strk
* unsigned int => size_t
*
* Revision 1.2 2006/06/08 11:20:24 strk
* Added missing virtual destructor to abstract classes.
*
* Revision 1.1 2006/03/21 10:47:34 strk
* indexStrtree.h split
*
**********************************************************************/
|