File: cpl_quad_tree.h

package info (click to toggle)
gdal 3.6.2%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 89,664 kB
  • sloc: cpp: 1,136,033; ansic: 197,355; python: 35,910; java: 5,511; xml: 4,011; sh: 3,950; cs: 2,443; yacc: 1,047; makefile: 288
file content (118 lines) | stat: -rw-r--r-- 4,926 bytes parent folder | download
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
/**********************************************************************
 * $Id$
 *
 * Project:  CPL - Common Portability Library
 * Purpose:  Implementation of quadtree building and searching functions.
 *           Derived from shapelib and mapserver implementations
 * Author:   Frank Warmerdam, warmerdam@pobox.com
 *           Even Rouault, <even dot rouault at spatialys.com>
 *
 ******************************************************************************
 * Copyright (c) 1999-2008, Frank Warmerdam
 * Copyright (c) 2008-2014, Even Rouault <even dot rouault at spatialys.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 ****************************************************************************/

#ifndef CPL_QUAD_TREE_H_INCLUDED
#define CPL_QUAD_TREE_H_INCLUDED

#include "cpl_port.h"

#include <stdbool.h>

/**
 * \file cpl_quad_tree.h
 *
 * Quad tree implementation.
 *
 * A quadtree is a tree data structure in which each internal node
 * has up to four children. Quadtrees are most often used to partition
 * a two dimensional space by recursively subdividing it into four
 * quadrants or regions
 */

CPL_C_START

/* Types */

/** Describe a rectangle */
typedef struct
{
    double minx; /**< Minimum x */
    double miny; /**< Minimum y */
    double maxx; /**< Maximum x */
    double maxy; /**< Maximum y */
} CPLRectObj;

/** Opaque type for a quad tree */
typedef struct _CPLQuadTree CPLQuadTree;

/** CPLQuadTreeGetBoundsFunc */
typedef void (*CPLQuadTreeGetBoundsFunc)(const void *hFeature,
                                         CPLRectObj *pBounds);
/** CPLQuadTreeGetBoundsExFunc */
typedef void (*CPLQuadTreeGetBoundsExFunc)(const void *hFeature,
                                           void *pUserData,
                                           CPLRectObj *pBounds);
/** CPLQuadTreeForeachFunc */
typedef int (*CPLQuadTreeForeachFunc)(void *pElt, void *pUserData);
/** CPLQuadTreeDumpFeatureFunc */
typedef void (*CPLQuadTreeDumpFeatureFunc)(const void *hFeature,
                                           int nIndentLevel, void *pUserData);

/* Functions */

CPLQuadTree CPL_DLL *CPLQuadTreeCreate(const CPLRectObj *pGlobalBounds,
                                       CPLQuadTreeGetBoundsFunc pfnGetBounds);
CPLQuadTree CPL_DLL *
CPLQuadTreeCreateEx(const CPLRectObj *pGlobalBounds,
                    CPLQuadTreeGetBoundsExFunc pfnGetBounds, void *pUserData);
void CPL_DLL CPLQuadTreeDestroy(CPLQuadTree *hQuadtree);

void CPL_DLL CPLQuadTreeSetBucketCapacity(CPLQuadTree *hQuadtree,
                                          int nBucketCapacity);
void CPL_DLL CPLQuadTreeForceUseOfSubNodes(CPLQuadTree *hQuadTree);
int CPL_DLL CPLQuadTreeGetAdvisedMaxDepth(int nExpectedFeatures);
void CPL_DLL CPLQuadTreeSetMaxDepth(CPLQuadTree *hQuadtree, int nMaxDepth);

void CPL_DLL CPLQuadTreeInsert(CPLQuadTree *hQuadtree, void *hFeature);
void CPL_DLL CPLQuadTreeInsertWithBounds(CPLQuadTree *hQuadtree, void *hFeature,
                                         const CPLRectObj *psBounds);

void CPL_DLL CPLQuadTreeRemove(CPLQuadTree *hQuadtree, void *hFeature,
                               const CPLRectObj *psBounds);

void CPL_DLL **CPLQuadTreeSearch(const CPLQuadTree *hQuadtree,
                                 const CPLRectObj *pAoi, int *pnFeatureCount);

void CPL_DLL CPLQuadTreeForeach(const CPLQuadTree *hQuadtree,
                                CPLQuadTreeForeachFunc pfnForeach,
                                void *pUserData);

void CPL_DLL CPLQuadTreeDump(const CPLQuadTree *hQuadtree,
                             CPLQuadTreeDumpFeatureFunc pfnDumpFeatureFunc,
                             void *pUserData);
void CPL_DLL CPLQuadTreeGetStats(const CPLQuadTree *hQuadtree,
                                 int *pnFeatureCount, int *pnNodeCount,
                                 int *pnMaxDepth, int *pnMaxBucketCapacity);

CPL_C_END

#endif