bloom-filter.h

Go to the documentation of this file.

/*
 
Copyright (c) 2005-2008, Simon Howard
 
Permission to use, copy, modify, and/or distribute this software 
for any purpose with or without fee is hereby granted, provided 
that the above copyright notice and this permission notice appear 
in all copies. 
 
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL 
WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED 
WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE 
AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR 
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, 
NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN      
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 
 
 */
 
#ifndef ALGORITHM_BLOOM_FILTER_H
#define ALGORITHM_BLOOM_FILTER_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct _BloomFilter BloomFilter;
 
typedef void *BloomFilterValue;
 
typedef unsigned long (*BloomFilterHashFunc)(BloomFilterValue data);
 
BloomFilter *bloom_filter_new(unsigned int table_size, 
                              BloomFilterHashFunc hash_func,
                              unsigned int num_functions);
 
void bloom_filter_free(BloomFilter *bloomfilter);
 
void bloom_filter_insert(BloomFilter *bloomfilter, BloomFilterValue value);
 
int bloom_filter_query(BloomFilter *bloomfilter, BloomFilterValue value);
 
void bloom_filter_read(BloomFilter *bloomfilter, unsigned char *array);
 
void bloom_filter_load(BloomFilter *bloomfilter, unsigned char *array);
 
BloomFilter *bloom_filter_union(BloomFilter *filter1, 
                                BloomFilter *filter2);
 
BloomFilter *bloom_filter_intersection(BloomFilter *filter1, 
                                       BloomFilter *filter2);
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef ALGORITHM_BLOOM_FILTER_H */