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
|
/*
This file is part of GNUnet
(C) 2012 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 2, or (at your
option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
/**
* @file consensus/ibf.h
* @brief invertible bloom filter
* @author Florian Dold
*/
/**
* Opaque handle to an invertible bloom filter (IBF).
*
* An IBF is a counting bloom filter that has the ability to restore
* the hashes of its stored elements with high probability.
*/
struct InvertibleBloomFilter
/**
* Create an invertible bloom filter.
*
* @param size number of IBF buckets
* @param salt salt for mingling hashes, different salt may
* result in less (or more) collisions
* @param hash_num number of buckets one element is hashed in
* @return the newly created invertible bloom filter
*/
struct InvertibleBloomFilter *
ibf_create(int size, int salt, int hash_num);
/**
* Insert an element into an IBF.
*
* @param ibf the IBF
* @param id the element's hash code
*/
void
ibf_insert (struct InvertibleBloomFilter *ibf, GNUNET_HashCode *id);
/**
* Subtract ibf2 from ibf1, storing the result in ibf1.
* The two IBF's must have the same parameters size and hash_num.
*/
void
ibf_subtract (struct InvertibleBloomFilter *ibf1, struct InvertibleBloomFilter *ibf2);
/**
* Decode and remove an element from the IBF, if possible.
*
* @param ibf the invertible bloom filter
* @param the id of the element is written to this hash code
* @return GNUNET_YES if decoding an element was successful, GNUNET_NO if it failed to decode
*/
int
ibf_decode (struct InvertibleBloomFilter *ibf, struct GNUNET_HashCode *ret_id);
/**
* Create a copy of an IBF, the copy has to be destroyed properly.
*
* @param ibf the IBF to copy
*/
struct InvertibleBloomFilter *
ibf_dup (struct InvertibleBloomFilter *ibf);
/*
ibf_hton();
ibf_ntoh();
*/
/**
* Destroy all resources associated with the invertible bloom filter.
* No more ibf_*-functions may be called on ibf after calling destroy.
*
* @param ibf the intertible bloom filter to destroy
*/
void
ibf_destroy (struct InvertibleBloomFilter *ibf);
|
