set.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_SET_H
#define ALGORITHM_SET_H
 
#ifdef __cplusplus
extern "C" {
#endif

 
typedef struct _Set Set;

 
typedef struct _SetIterator SetIterator;

 
typedef struct _SetEntry SetEntry;

 
typedef void *SetValue;

 
struct _SetIterator {
    Set *set;
    SetEntry *next_entry;
    int next_chain;
};

 
#define SET_NULL ((void *) 0)

 
typedef unsigned long (*SetHashFunc)(SetValue value);

 
typedef int (*SetEqualFunc)(SetValue value1, SetValue value2);

 
typedef void (*SetFreeFunc)(SetValue value);

 
Set *set_new(SetHashFunc hash_func, SetEqualFunc equal_func);

 
void set_free(Set *set);

 
void set_register_free_function(Set *set, SetFreeFunc free_func);

 
int set_insert(Set *set, SetValue data);

 
int set_remove(Set *set, SetValue data);

 
int set_query(Set *set, SetValue data);

 
int set_num_entries(Set *set);

 
SetValue *set_to_array(Set *set);

 
Set *set_union(Set *set1, Set *set2);

 
Set *set_intersection(Set *set1, Set *set2); 

 
void set_iterate(Set *set, SetIterator *iter);

 
int set_iter_has_more(SetIterator *iterator);

 
SetValue set_iter_next(SetIterator *iterator);
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef ALGORITHM_SET_H */