GDAL
cpl_quad_tree.h
Go to the documentation of this file.
1 /**********************************************************************
2  * $Id: cpl_quad_tree.h 34931 2016-08-05 17:13:05Z rouault $
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 mines dash paris dot org>
9  *
10  ******************************************************************************
11  * Copyright (c) 1999-2008, Frank Warmerdam
12  * Copyright (c) 2008-2014, Even Rouault <even dot rouault at mines-paris dot org>
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 
50 
51 /* Types */
52 
54 typedef struct {
55  double minx;
56  double miny;
57  double maxx;
58  double maxy;
59 } CPLRectObj;
60 
62 typedef struct _CPLQuadTree CPLQuadTree;
63 
65 typedef void (*CPLQuadTreeGetBoundsFunc)(const void* hFeature, CPLRectObj* pBounds);
67 typedef int (*CPLQuadTreeForeachFunc)(void* pElt, void* pUserData);
69 typedef void (*CPLQuadTreeDumpFeatureFunc)(const void* hFeature, int nIndentLevel, void* pUserData);
70 
71 /* Functions */
72 
73 CPLQuadTree CPL_DLL *CPLQuadTreeCreate(const CPLRectObj* pGlobalBounds,
74  CPLQuadTreeGetBoundsFunc pfnGetBounds);
75 void CPL_DLL CPLQuadTreeDestroy(CPLQuadTree *hQuadtree);
76 
77 void CPL_DLL CPLQuadTreeSetBucketCapacity(CPLQuadTree *hQuadtree,
78  int nBucketCapacity);
79 int CPL_DLL CPLQuadTreeGetAdvisedMaxDepth(int nExpectedFeatures);
80 void CPL_DLL CPLQuadTreeSetMaxDepth(CPLQuadTree *hQuadtree,
81  int nMaxDepth);
82 
83 void CPL_DLL CPLQuadTreeInsert(CPLQuadTree *hQuadtree,
84  void* hFeature);
85 void CPL_DLL CPLQuadTreeInsertWithBounds(CPLQuadTree *hQuadtree,
86  void* hFeature,
87  const CPLRectObj* psBounds);
88 
89 void CPL_DLL **CPLQuadTreeSearch(const CPLQuadTree *hQuadtree,
90  const CPLRectObj* pAoi,
91  int* pnFeatureCount);
92 
93 void CPL_DLL CPLQuadTreeForeach(const CPLQuadTree *hQuadtree,
94  CPLQuadTreeForeachFunc pfnForeach,
95  void* pUserData);
96 
97 void CPL_DLL CPLQuadTreeDump(const CPLQuadTree *hQuadtree,
98  CPLQuadTreeDumpFeatureFunc pfnDumpFeatureFunc,
99  void* pUserData);
100 void CPL_DLL CPLQuadTreeGetStats(const CPLQuadTree *hQuadtree,
101  int* pnFeatureCount,
102  int* pnNodeCount,
103  int* pnMaxDepth,
104  int* pnMaxBucketCapacity);
105 
106 CPL_C_END
107 
108 #endif
void CPLQuadTreeInsert(CPLQuadTree *hQuadtree, void *hFeature)
Insert a feature into a quadtree.
Definition: cpl_quad_tree.cpp:271
void(* CPLQuadTreeGetBoundsFunc)(const void *hFeature, CPLRectObj *pBounds)
CPLQuadTreeGetBoundsFunc.
Definition: cpl_quad_tree.h:65
Core portability definitions for CPL.
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:352
double miny
Minimum y.
Definition: cpl_quad_tree.h:56
double maxy
Maximum y.
Definition: cpl_quad_tree.h:58
int(* CPLQuadTreeForeachFunc)(void *pElt, void *pUserData)
CPLQuadTreeForeachFunc.
Definition: cpl_quad_tree.h:67
double maxx
Maximum x.
Definition: cpl_quad_tree.h:57
void(* CPLQuadTreeDumpFeatureFunc)(const void *hFeature, int nIndentLevel, void *pUserData)
CPLQuadTreeDumpFeatureFunc.
Definition: cpl_quad_tree.h:69
void CPLQuadTreeDump(const CPLQuadTree *hQuadtree, CPLQuadTreeDumpFeatureFunc pfnDumpFeatureFunc, void *pUserData)
Dump quad tree.
Definition: cpl_quad_tree.cpp:816
int CPLQuadTreeGetAdvisedMaxDepth(int nExpectedFeatures)
Returns the optimal depth of a quadtree to hold nExpectedFeatures.
Definition: cpl_quad_tree.cpp:188
CPLQuadTree * CPLQuadTreeCreate(const CPLRectObj *pGlobalBounds, CPLQuadTreeGetBoundsFunc pfnGetBounds)
Create a new quadtree.
Definition: cpl_quad_tree.cpp:149
struct _CPLQuadTree CPLQuadTree
Opaque type for a quad tree.
Definition: cpl_quad_tree.h:62
void CPLQuadTreeGetStats(const CPLQuadTree *hQuadtree, int *pnFeatureCount, int *pnNodeCount, int *pnMaxDepth, int *pnMaxBucketCapacity)
Get stats.
Definition: cpl_quad_tree.cpp:852
Describe a rectangle.
Definition: cpl_quad_tree.h:54
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:686
void CPLQuadTreeSetMaxDepth(CPLQuadTree *hQuadtree, int nMaxDepth)
Set the maximum depth of a quadtree.
Definition: cpl_quad_tree.cpp:236
double minx
Minimum x.
Definition: cpl_quad_tree.h:55
void CPLQuadTreeInsertWithBounds(CPLQuadTree *hQuadtree, void *hFeature, const CPLRectObj *psBounds)
Insert a feature into a quadtree.
Definition: cpl_quad_tree.cpp:296
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:354
void CPLQuadTreeSetBucketCapacity(CPLQuadTree *hQuadtree, int nBucketCapacity)
Set the maximum capacity of a node of a quadtree.
Definition: cpl_quad_tree.cpp:254
void CPLQuadTreeDestroy(CPLQuadTree *hQuadtree)
Destroy a quadtree.
Definition: cpl_quad_tree.cpp:335
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:751

Generated for GDAL by doxygen 1.8.8.