GDAL

cpl_hash_set.h
Go to the documentation of this file.
1/**********************************************************************
2 * $Id$
3 *
4 * Name: cpl_hash_set.h
5 * Project: CPL - Common Portability Library
6 * Purpose: Hash set functions.
7 * Author: Even Rouault, <even dot rouault at spatialys.com>
8 *
9 **********************************************************************
10 * Copyright (c) 2008-2009, Even Rouault <even dot rouault at spatialys.com>
11 *
12 * Permission is hereby granted, free of charge, to any person obtaining a
13 * copy of this software and associated documentation files (the "Software"),
14 * to deal in the Software without restriction, including without limitation
15 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
16 * and/or sell copies of the Software, and to permit persons to whom the
17 * Software is furnished to do so, subject to the following conditions:
18 *
19 * The above copyright notice and this permission notice shall be included
20 * in all copies or substantial portions of the Software.
21 *
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
25 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
27 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
28 * DEALINGS IN THE SOFTWARE.
29 ****************************************************************************/
30
31#ifndef CPL_HASH_SET_H_INCLUDED
32#define CPL_HASH_SET_H_INCLUDED
33
34#include "cpl_port.h"
35
47 CPL_C_START
48
49/* Types */
50
52 typedef struct _CPLHashSet CPLHashSet;
53
55 typedef unsigned long (*CPLHashSetHashFunc)(const void *elt);
56
58 typedef int (*CPLHashSetEqualFunc)(const void *elt1, const void *elt2);
59
61 typedef void (*CPLHashSetFreeEltFunc)(void *elt);
62
64 typedef int (*CPLHashSetIterEltFunc)(void *elt, void *user_data);
65
66/* Functions */
67
68 CPLHashSet CPL_DLL *CPLHashSetNew(CPLHashSetHashFunc fnHashFunc,
69 CPLHashSetEqualFunc fnEqualFunc,
70 CPLHashSetFreeEltFunc fnFreeEltFunc);
71
72void CPL_DLL CPLHashSetDestroy(CPLHashSet *set);
73
74void CPL_DLL CPLHashSetClear(CPLHashSet *set);
75
76int CPL_DLL CPLHashSetSize(const CPLHashSet *set);
77
78void CPL_DLL CPLHashSetForeach(CPLHashSet *set,
79 CPLHashSetIterEltFunc fnIterFunc,
80 void *user_data);
81
82int CPL_DLL CPLHashSetInsert(CPLHashSet *set, void *elt);
83
84void CPL_DLL *CPLHashSetLookup(CPLHashSet *set, const void *elt);
85
86int CPL_DLL CPLHashSetRemove(CPLHashSet *set, const void *elt);
87int CPL_DLL CPLHashSetRemoveDeferRehash(CPLHashSet *set, const void *elt);
88
89unsigned long CPL_DLL CPLHashSetHashPointer(const void *elt);
90
91int CPL_DLL CPLHashSetEqualPointer(const void *elt1, const void *elt2);
92
93unsigned long CPL_DLL CPLHashSetHashStr(const void *pszStr);
94
95int CPL_DLL CPLHashSetEqualStr(const void *pszStr1, const void *pszStr2);
96
97 CPL_C_END
98
99#endif /* CPL_HASH_SET_H_INCLUDED */
CPLHashSetRemove
int CPLHashSetRemove(CPLHashSet *set, const void *elt)
Removes an element from a hash set.
Definition: cpl_hash_set.cpp:470
CPLHashSetHashFunc
unsigned long(* CPLHashSetHashFunc)(const void *elt)
CPLHashSetHashFunc.
Definition: cpl_hash_set.h:55
CPLHashSetHashPointer
unsigned long CPLHashSetHashPointer(const void *elt)
Hash function for an arbitrary pointer.
Definition: cpl_hash_set.cpp:509
CPLHashSet
struct _CPLHashSet CPLHashSet
Opaque type for a hash set.
Definition: cpl_hash_set.h:52
CPLHashSetEqualPointer
int CPLHashSetEqualPointer(const void *elt1, const void *elt2)
Equality function for arbitrary pointers.
Definition: cpl_hash_set.cpp:528
CPLHashSetLookup
void * CPLHashSetLookup(CPLHashSet *set, const void *elt)
Returns the element found in the hash set corresponding to the element to look up The element must no...
Definition: cpl_hash_set.cpp:401
CPLHashSetDestroy
void CPLHashSetDestroy(CPLHashSet *set)
Destroys an allocated hash set.
Definition: cpl_hash_set.cpp:202
CPLHashSetClear
void CPLHashSetClear(CPLHashSet *set)
Clear all elements from a hash set.
Definition: cpl_hash_set.cpp:224
CPLHashSetSize
int CPLHashSetSize(const CPLHashSet *set)
Returns the number of elements inserted in the hash set.
Definition: cpl_hash_set.cpp:121
CPLHashSetInsert
int CPLHashSetInsert(CPLHashSet *set, void *elt)
Inserts an element into a hash set.
Definition: cpl_hash_set.cpp:351
CPLHashSetHashStr
unsigned long CPLHashSetHashStr(const void *pszStr)
Hash function for a zero-terminated string.
Definition: cpl_hash_set.cpp:546
CPLHashSetForeach
void CPLHashSetForeach(CPLHashSet *set, CPLHashSetIterEltFunc fnIterFunc, void *user_data)
Walk through the hash set and runs the provided function on all the elements.
Definition: cpl_hash_set.cpp:257
CPLHashSetNew
CPLHashSet * CPLHashSetNew(CPLHashSetHashFunc fnHashFunc, CPLHashSetEqualFunc fnEqualFunc, CPLHashSetFreeEltFunc fnFreeEltFunc)
Creates a new hash set.
Definition: cpl_hash_set.cpp:86
CPLHashSetIterEltFunc
int(* CPLHashSetIterEltFunc)(void *elt, void *user_data)
CPLHashSetIterEltFunc.
Definition: cpl_hash_set.h:64
CPLHashSetFreeEltFunc
void(* CPLHashSetFreeEltFunc)(void *elt)
CPLHashSetFreeEltFunc.
Definition: cpl_hash_set.h:61
CPLHashSetEqualStr
int CPLHashSetEqualStr(const void *pszStr1, const void *pszStr2)
Equality function for strings.
Definition: cpl_hash_set.cpp:574
CPLHashSetEqualFunc
int(* CPLHashSetEqualFunc)(const void *elt1, const void *elt2)
CPLHashSetEqualFunc.
Definition: cpl_hash_set.h:58
CPLHashSetRemoveDeferRehash
int CPLHashSetRemoveDeferRehash(CPLHashSet *set, const void *elt)
Removes an element from a hash set.
Definition: cpl_hash_set.cpp:492
cpl_port.h
Core portability definitions for CPL.
CPL_C_END
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:299
CPL_C_START
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:295