GDAL

cpl_quad_tree.h
Go to the documentation of this file.
1 /**********************************************************************
2 * $Id$
3 *
4 * Project: CPL - Common Portability Library
5 * Purpose: Implementation of quadtree building and searching functions.
6 * Derived from shapelib and mapserver implementations
7 * Author: Frank Warmerdam, warmerdam@pobox.com
8 * Even Rouault, <even dot rouault at spatialys.com>
9 *
10 ******************************************************************************
11 * Copyright (c) 1999-2008, Frank Warmerdam
12 * Copyright (c) 2008-2014, Even Rouault <even dot rouault at spatialys.com>
13 *
14 * Permission is hereby granted, free of charge, to any person obtaining a
15 * copy of this software and associated documentation files (the "Software"),
16 * to deal in the Software without restriction, including without limitation
17 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
18 * and/or sell copies of the Software, and to permit persons to whom the
19 * Software is furnished to do so, subject to the following conditions:
20 *
21 * The above copyright notice and this permission notice shall be included
22 * in all copies or substantial portions of the Software.
23 *
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
30 * DEALINGS IN THE SOFTWARE.
31 ****************************************************************************/
32
33 #ifndef CPL_QUAD_TREE_H_INCLUDED
34 #define CPL_QUAD_TREE_H_INCLUDED
35
36 #include "cpl_port.h"
37
38 #include <stdbool.h>
39
51 CPL_C_START
52
53 /* Types */
54
56 typedef struct
57 {
58 double minx;
59 double miny;
60 double maxx;
61 double maxy;
62 } CPLRectObj;
63
65 typedef struct _CPLQuadTree CPLQuadTree;
66
68 typedef void (*CPLQuadTreeGetBoundsFunc)(const void *hFeature,
69 CPLRectObj *pBounds);
71 typedef void (*CPLQuadTreeGetBoundsExFunc)(const void *hFeature,
72 void *pUserData,
73 CPLRectObj *pBounds);
75 typedef int (*CPLQuadTreeForeachFunc)(void *pElt, void *pUserData);
77 typedef void (*CPLQuadTreeDumpFeatureFunc)(const void *hFeature,
78 int nIndentLevel, void *pUserData);
79
80 /* Functions */
81
82 CPLQuadTree CPL_DLL *CPLQuadTreeCreate(const CPLRectObj *pGlobalBounds,
83 CPLQuadTreeGetBoundsFunc pfnGetBounds);
84 CPLQuadTree CPL_DLL *
85 CPLQuadTreeCreateEx(const CPLRectObj *pGlobalBounds,
86 CPLQuadTreeGetBoundsExFunc pfnGetBounds, void *pUserData);
87 void CPL_DLL CPLQuadTreeDestroy(CPLQuadTree *hQuadtree);
88
89 void CPL_DLL CPLQuadTreeSetBucketCapacity(CPLQuadTree *hQuadtree,
90 int nBucketCapacity);
91 void CPL_DLL CPLQuadTreeForceUseOfSubNodes(CPLQuadTree *hQuadTree);
92 int CPL_DLL CPLQuadTreeGetAdvisedMaxDepth(int nExpectedFeatures);
93 void CPL_DLL CPLQuadTreeSetMaxDepth(CPLQuadTree *hQuadtree, int nMaxDepth);
94
95 void CPL_DLL CPLQuadTreeInsert(CPLQuadTree *hQuadtree, void *hFeature);
96 void CPL_DLL CPLQuadTreeInsertWithBounds(CPLQuadTree *hQuadtree, void *hFeature,
97 const CPLRectObj *psBounds);
98
99 void CPL_DLL CPLQuadTreeRemove(CPLQuadTree *hQuadtree, void *hFeature,
100 const CPLRectObj *psBounds);
101
102 void CPL_DLL **CPLQuadTreeSearch(const CPLQuadTree *hQuadtree,
103 const CPLRectObj *pAoi, int *pnFeatureCount);
104
105 void CPL_DLL CPLQuadTreeForeach(const CPLQuadTree *hQuadtree,
106 CPLQuadTreeForeachFunc pfnForeach,
107 void *pUserData);
108
109 void CPL_DLL CPLQuadTreeDump(const CPLQuadTree *hQuadtree,
110 CPLQuadTreeDumpFeatureFunc pfnDumpFeatureFunc,
111 void *pUserData);
112 void CPL_DLL CPLQuadTreeGetStats(const CPLQuadTree *hQuadtree,
113 int *pnFeatureCount, int *pnNodeCount,
114 int *pnMaxDepth, int *pnMaxBucketCapacity);
115
116 CPL_C_END
117
118 #endif
CPLQuadTreeGetAdvisedMaxDepth
int CPLQuadTreeGetAdvisedMaxDepth(int nExpectedFeatures)
Returns the optimal depth of a quadtree to hold nExpectedFeatures.
Definition: cpl_quad_tree.cpp:247
CPLQuadTreeDumpFeatureFunc
void(* CPLQuadTreeDumpFeatureFunc)(const void *hFeature, int nIndentLevel, void *pUserData)
CPLQuadTreeDumpFeatureFunc.
Definition: cpl_quad_tree.h:77
CPLQuadTreeSearch
void ** CPLQuadTreeSearch(const CPLQuadTree *hQuadtree, const CPLRectObj *pAoi, int *pnFeatureCount)
Returns all the elements inserted whose bounding box intersects the provided area of interest.
Definition: cpl_quad_tree.cpp:907
CPLQuadTreeSetBucketCapacity
void CPLQuadTreeSetBucketCapacity(CPLQuadTree *hQuadtree, int nBucketCapacity)
Set the maximum capacity of a node of a quadtree.
Definition: cpl_quad_tree.cpp:312
CPLRectObj::miny
double miny
Minimum y.
Definition: cpl_quad_tree.h:59
CPLRectObj::maxy
double maxy
Maximum y.
Definition: cpl_quad_tree.h:61
CPLQuadTreeInsertWithBounds
void CPLQuadTreeInsertWithBounds(CPLQuadTree *hQuadtree, void *hFeature, const CPLRectObj *psBounds)
Insert a feature into a quadtree.
Definition: cpl_quad_tree.cpp:375
CPLQuadTree
struct _CPLQuadTree CPLQuadTree
Opaque type for a quad tree.
Definition: cpl_quad_tree.h:65
CPLQuadTreeInsert
void CPLQuadTreeInsert(CPLQuadTree *hQuadtree, void *hFeature)
Insert a feature into a quadtree.
Definition: cpl_quad_tree.cpp:346
CPL_C_START
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:315
CPLRectObj::maxx
double maxx
Maximum x.
Definition: cpl_quad_tree.h:60
CPLQuadTreeForeach
void CPLQuadTreeForeach(const CPLQuadTree *hQuadtree, CPLQuadTreeForeachFunc pfnForeach, void *pUserData)
Walk through the quadtree and runs the provided function on all the elements.
Definition: cpl_quad_tree.cpp:971
CPLQuadTreeDump
void CPLQuadTreeDump(const CPLQuadTree *hQuadtree, CPLQuadTreeDumpFeatureFunc pfnDumpFeatureFunc, void *pUserData)
Dump quad tree.
Definition: cpl_quad_tree.cpp:1034
CPL_C_END
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:319
CPLQuadTreeCreate
CPLQuadTree * CPLQuadTreeCreate(const CPLRectObj *pGlobalBounds, CPLQuadTreeGetBoundsFunc pfnGetBounds)
Create a new quadtree.
Definition: cpl_quad_tree.cpp:154
CPLRectObj
Describe a rectangle.
Definition: cpl_quad_tree.h:56
CPLQuadTreeRemove
void CPLQuadTreeRemove(CPLQuadTree *hQuadtree, void *hFeature, const CPLRectObj *psBounds)
Remove a feature from a quadtree.
Definition: cpl_quad_tree.cpp:458
CPLRectObj::minx
double minx
Minimum x.
Definition: cpl_quad_tree.h:58
CPLQuadTreeForceUseOfSubNodes
void CPLQuadTreeForceUseOfSubNodes(CPLQuadTree *hQuadTree)
Force the quadtree to insert as much as possible a feature whose bbox spread over multiple subnodes i...
Definition: cpl_quad_tree.cpp:330
cpl_port.h
CPLQuadTreeForeachFunc
int(* CPLQuadTreeForeachFunc)(void *pElt, void *pUserData)
CPLQuadTreeForeachFunc.
Definition: cpl_quad_tree.h:75
CPLQuadTreeDestroy
void CPLQuadTreeDestroy(CPLQuadTree *hQuadtree)
Destroy a quadtree.
Definition: cpl_quad_tree.cpp:514
CPLQuadTreeCreateEx
CPLQuadTree * CPLQuadTreeCreateEx(const CPLRectObj *pGlobalBounds, CPLQuadTreeGetBoundsExFunc pfnGetBounds, void *pUserData)
Create a new quadtree.
Definition: cpl_quad_tree.cpp:203
CPLQuadTreeSetMaxDepth
void CPLQuadTreeSetMaxDepth(CPLQuadTree *hQuadtree, int nMaxDepth)
Set the maximum depth of a quadtree.
Definition: cpl_quad_tree.cpp:294
CPLQuadTreeGetBoundsExFunc
void(* CPLQuadTreeGetBoundsExFunc)(const void *hFeature, void *pUserData, CPLRectObj *pBounds)
CPLQuadTreeGetBoundsExFunc.
Definition: cpl_quad_tree.h:71
CPLQuadTreeGetStats
void CPLQuadTreeGetStats(const CPLQuadTree *hQuadtree, int *pnFeatureCount, int *pnNodeCount, int *pnMaxDepth, int *pnMaxBucketCapacity)
Get stats.
Definition: cpl_quad_tree.cpp:1067
CPLQuadTreeGetBoundsFunc
void(* CPLQuadTreeGetBoundsFunc)(const void *hFeature, CPLRectObj *pBounds)
CPLQuadTreeGetBoundsFunc.
Definition: cpl_quad_tree.h:68