[bison.git] / lib / bitset.h

/* Generic bitsets.
   Copyright (C) 2002 Free Software Foundation, Inc.
   Contributed by Michael Hayes (m.hayes@elec.canterbury.ac.nz).

This program 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 of the License, or
(at your option) any later version.

This program 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 this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */

#ifndef _BITSET_H
#define _BITSET_H

/* This file is the public interface to the bitset abstract data type.
   Only use the functions and macros defined in this file.  */

#include "bbitset.h"
#include "obstack.h"
#include <stdio.h>

/* Attributes used to select a bitset implementation.  */
enum bitset_attr {BITSET_FIXED = 1,    /* Bitset size fixed.  */
		  BITSET_VARIABLE = 2, /* Bitset size variable.  */
		  BITSET_DENSE = 4,    /* Bitset dense.  */
		  BITSET_SPARSE = 8,   /* Bitset sparse.  */
		  BITSET_FRUGAL = 16,  /* Prefer most compact.  */
		  BITSET_GREEDY = 32}; /* Prefer fastest at memory expense.  */

typedef unsigned int bitset_attrs;

/* The contents of the union should be considered to be private.
   While I would like to make this union opaque, it needs to be
   visible for the inline bit set/test functions, and for delegation
   to the proper implementation.  */
union bitset_union
{
  /* This must be the first member of every other structure that is a
     member of this union.  */
  struct bbitset_struct b;

  struct abitset_struct
  {
    struct bbitset_struct b;
    bitset_bindex n_bits;		/* Number of bits.  */
    bitset_word words[1];		/* The array of bits.  */
  } a;

  struct ebitset_struct
  {
    struct bbitset_struct b;
    bitset_windex size;			/* Number of elements.  */
    struct ebitset_elt_struct **elts;	/* Expanding array of ptrs to elts.  */
  } e;

  struct lbitset_struct
  {
    struct bbitset_struct b;
    struct lbitset_elt_struct *head;	/* First element in linked list.  */
    struct lbitset_elt_struct *tail;	/* Last element in linked list.  */
  } l;

  struct bitset_stats_struct
  {
    struct bbitset_struct b;
    bitset bset;
  } s;
};


/* The contents of this structure should be considered private.
   It is used for iterating over set bits.  */
typedef struct
{
  bitset_bindex list[BITSET_LIST_SIZE];
  bitset_bindex next;
  bitset_bindex num;
  bitset_bindex i;
} bitset_iterator;


/* Return bytes required for bitset of desired type and size.  */
extern size_t bitset_bytes PARAMS ((enum bitset_type, bitset_bindex));

/* Initialise a bitset with desired type and size.  */
extern bitset bitset_init PARAMS ((bitset, bitset_bindex, enum bitset_type));

/* Select an implementation type based on the desired bitset size
   and attributes.  */
extern enum bitset_type bitset_type_choose PARAMS ((bitset_bindex,
						    bitset_attrs));

/* Create a bitset of desired type and size.  The bitset is zeroed.  */
extern bitset bitset_alloc PARAMS ((bitset_bindex, enum bitset_type));

/* Free bitset.  */
extern void bitset_free PARAMS ((bitset));

/* Create a bitset of desired type and size using an obstack.  The
   bitset is zeroed.  */
extern bitset bitset_obstack_alloc PARAMS ((struct obstack *bobstack,
					    bitset_bindex, enum bitset_type));

/* Free bitset allocated on obstack.  */
extern void bitset_obstack_free PARAMS ((bitset));

/* Create a bitset of desired size and attributes.  The bitset is zeroed.  */
extern bitset bitset_create PARAMS ((bitset_bindex, bitset_attrs));

/* Return bitset type.  */
extern enum bitset_type bitset_type_get PARAMS ((bitset));

/* Return bitset type name.  */
extern const char *bitset_type_name_get PARAMS ((bitset));


/* Set bit BITNO in bitset BSET.  */
static inline void
bitset_set (bitset bset, bitset_bindex bitno)
{
  bitset_windex windex = bitno / BITSET_WORD_BITS;
  bitset_windex offset = windex - bset->b.cindex;

  if (offset < bset->b.csize)
    bset->b.cdata[offset] |= ((bitset_word) 1 << (bitno % BITSET_WORD_BITS));
  else
    BITSET_SET_ (bset, bitno);
}


/* Reset bit BITNO in bitset BSET.  */
static inline void
bitset_reset (bitset bset, bitset_bindex bitno)
{
  bitset_windex windex = bitno / BITSET_WORD_BITS;
  bitset_windex offset = windex - bset->b.cindex;

  if (offset < bset->b.csize)
    bset->b.cdata[offset] &= ~((bitset_word) 1 << (bitno % BITSET_WORD_BITS));
  else
    BITSET_RESET_ (bset, bitno);
}


/* Test bit BITNO in bitset BSET.  */
static inline int
bitset_test (bitset bset, bitset_bindex bitno)
{
  bitset_windex windex = bitno / BITSET_WORD_BITS;
  bitset_windex offset = windex - bset->b.cindex;

  if (offset < bset->b.csize)
    return (bset->b.cdata[offset] >> (bitno % BITSET_WORD_BITS)) & 1;
  else
    return BITSET_TEST_ (bset, bitno);
}


/* Toggle bit BITNO in bitset BSET and return non-zero if now set.  */
#define bitset_toggle(bset, bitno) BITSET_TOGGLE_ (bset, bitno)

/* Return size in bits of bitset SRC.  */
#define bitset_size(SRC) BITSET_SIZE_ (SRC)

/* Return number of bits set in bitset SRC.  */
#define bitset_count(SRC) BITSET_COUNT_ (SRC)


/* Return SRC == 0.  */
#define bitset_empty_p(SRC) BITSET_EMPTY_P_ (SRC)

/* DST = ~0.  */
#define bitset_ones(DST) BITSET_ONES_ (DST)

/* DST = 0.  */
#define bitset_zero(DST) BITSET_ZERO_ (DST)


/* DST = SRC.  */
#define bitset_copy(DST, SRC) BITSET_COPY_ (DST, SRC)

/* Return DST & SRC == 0.  */
#define bitset_disjoint_p(DST, SRC) BITSET_DISJOINT_P_ (DST, SRC)

/* Return DST == SRC.  */
#define bitset_equal_p(DST, SRC) BITSET_EQUAL_P_ (DST, SRC)

/* DST = ~SRC.  */
#define bitset_not(DST, SRC) BITSET_NOT_ (DST, SRC)

/* Return DST == DST | SRC.  */
#define bitset_subset_p(DST, SRC) BITSET_SUBSET_P_ (DST, SRC)


/* DST = SRC1 & SRC2.  */
#define bitset_and(DST, SRC1, SRC2) BITSET_AND_ (DST, SRC1, SRC2)

/* DST = SRC1 & SRC2.  Return non-zero if DST != SRC1 & SRC2.  */
#define bitset_and_cmp(DST, SRC1, SRC2) BITSET_AND_CMP_ (DST, SRC1, SRC2)

/* DST = SRC1 & ~SRC2.  */
#define bitset_andn(DST, SRC1, SRC2) BITSET_ANDN_ (DST, SRC1, SRC2)

/* DST = SRC1 & ~SRC2.  Return non-zero if DST != SRC1 & ~SRC2.  */
#define bitset_andn_cmp(DST, SRC1, SRC2) BITSET_ANDN_CMP_ (DST, SRC1, SRC2)

/* DST = SRC1 | SRC2.  */
#define bitset_or(DST, SRC1, SRC2) BITSET_OR_ (DST, SRC1, SRC2)

/* DST = SRC1 | SRC2.  Return non-zero if DST != SRC1 | SRC2.  */
#define bitset_or_cmp(DST, SRC1, SRC2) BITSET_OR_CMP_ (DST, SRC1, SRC2)

/* DST = SRC1 ^ SRC2.  */
#define bitset_xor(DST, SRC1, SRC2) BITSET_XOR_ (DST, SRC1, SRC2)

/* DST = SRC1 ^ SRC2.  Return non-zero if DST != SRC1 ^ SRC2.  */
#define bitset_xor_cmp(DST, SRC1, SRC2) BITSET_XOR_CMP_ (DST, SRC1, SRC2)


/* DST = (SRC1 & SRC2) | SRC3.  */
#define bitset_and_or(DST, SRC1, SRC2, SRC3) \
 BITSET_AND_OR_ (DST, SRC1, SRC2, SRC3)

/* DST = (SRC1 & SRC2) | SRC3.  Return non-zero if
   DST != (SRC1 & SRC2) | SRC3.  */
#define bitset_and_or_cmp(DST, SRC1, SRC2, SRC3) \
 BITSET_AND_OR_CMP_ (DST, SRC1, SRC2, SRC3)

/* DST = (SRC1 & ~SRC2) | SRC3.  */
#define bitset_andn_or(DST, SRC1, SRC2, SRC3) \
 BITSET_ANDN_OR_ (DST, SRC1, SRC2, SRC3)

/* DST = (SRC1 & ~SRC2) | SRC3.  Return non-zero if
   DST != (SRC1 & ~SRC2) | SRC3.  */
#define bitset_andn_or_cmp(DST, SRC1, SRC2, SRC3) \
 BITSET_ANDN_OR_CMP_ (DST, SRC1, SRC2, SRC3)

/* DST = (SRC1 | SRC2) & SRC3.  */
#define bitset_or_and(DST, SRC1, SRC2, SRC3)\
 BITSET_OR_AND_ (DST, SRC1, SRC2, SRC3)

/* DST = (SRC1 | SRC2) & SRC3.  Return non-zero if
   DST != (SRC1 | SRC2) & SRC3.  */
#define bitset_or_and_cmp(DST, SRC1, SRC2, SRC3)\
 BITSET_OR_AND_CMP_ (DST, SRC1, SRC2, SRC3)

/* Find list of up to NUM bits set in BSET starting from and including
   *NEXT.  Return with actual number of bits found and with *NEXT
   indicating where search stopped.  */
#define bitset_list(BSET, LIST, NUM, NEXT) \
 BITSET_LIST_ (BSET, LIST, NUM, NEXT)

/* Find reverse list of up to NUM bits set in BSET starting from and
   including NEXT.  Return with actual number of bits found and with
   *NEXT indicating where search stopped.  */
#define bitset_list_reverse(BSET, LIST, NUM, NEXT) \
 BITSET_LIST_REVERSE_ (BSET, LIST, NUM, NEXT)


/* Find next set bit.  */
extern bitset_bindex bitset_next PARAMS ((bitset, bitset_bindex));

/* Find previous set bit.  */
extern bitset_bindex bitset_prev PARAMS ((bitset, bitset_bindex));

/* Find first set bit.  */
extern bitset_bindex bitset_first PARAMS ((bitset));

/* Find last set bit.  */
extern bitset_bindex bitset_last PARAMS ((bitset));

/* Return nonzero if this is the only set bit.  */
extern int bitset_only_set_p PARAMS ((bitset, bitset_bindex));

/* Dump bitset.  */
extern void bitset_dump PARAMS ((FILE *, bitset));

/* Loop over all elements of BSET, starting with MIN, setting BIT
   to the index of each set bit.  For example, the following will print
   the bits set in a bitset:

   bitset_bindex i;
   bitset_iterator iter;

   bitset_zero (dst);
   BITSET_FOR_EACH (iter, src, i, 0)
   {
      printf ("%ld ", i);
   };
*/
#define BITSET_FOR_EACH(ITER, BSET, BIT, MIN)				      \
  for (ITER.next = (MIN), ITER.num = BITSET_LIST_SIZE;			      \
       (ITER.num == BITSET_LIST_SIZE) 					      \
       && (ITER.num = bitset_list (BSET, ITER.list, 			      \
				   BITSET_LIST_SIZE, &ITER.next));)	      \
    for (ITER.i = 0; (BIT) = ITER.list[ITER.i], ITER.i < ITER.num; ITER.i++)


/* Loop over all elements of BSET, in reverse order starting with
   MIN,  setting BIT to the index of each set bit. For example, the
   following will print the bits set in a bitset in reverse order:

   bitset_bindex i;
   bitset_iterator iter;

   bitset_zero (dst);
   BITSET_FOR_EACH_REVERSE (iter, src, i, 0)
   {
      printf ("%ld ", i);
   };
*/
#define BITSET_FOR_EACH_REVERSE(ITER, BSET, BIT, MIN)			      \
  for (ITER.next = (MIN), ITER.num = BITSET_LIST_SIZE;			      \
       (ITER.num == BITSET_LIST_SIZE) 					      \
       && (ITER.num = bitset_list_reverse (BSET, ITER.list,		      \
					  BITSET_LIST_SIZE, &ITER.next));)    \
    for (ITER.i = 0; (BIT) = ITER.list[ITER.i], ITER.i < ITER.num; ITER.i++)


/* Define set operations in terms of logical operations.  */

#define bitset_diff(DST, SRC1, SRC2) bitset_andn (DST, SRC1, SRC2)
#define bitset_diff_cmp(DST, SRC1, SRC2) bitset_andn_cmp (DST, SRC1, SRC2)

#define bitset_intersection(DST, SRC1, SRC2) bitset_and (DST, SRC1, SRC2)
#define bitset_intersection_cmp(DST, SRC1, SRC2) bitset_and_cmp (DST, SRC1, SRC2)

#define bitset_union(DST, SRC1, SRC2) bitset_or (DST, SRC1, SRC2)
#define bitset_union_cmp(DST, SRC1, SRC2) bitset_or_cmp (DST, SRC1, SRC2)

/* Symmetrical difference.  */
#define bitset_symdiff(DST, SRC1, SRC2) bitset_xor (DST, SRC1, SRC2)
#define bitset_symdiff_cmp(DST, SRC1, SRC2) bitset_xor_cmp (DST, SRC1, SRC2)

/* Union of difference.  */
#define bitset_diff_union(DST, SRC1, SRC2, SRC3) \
  bitset_andn_or (DST, SRC1, SRC2, SRC3)
#define bitset_diff_union_cmp(DST, SRC1, SRC2, SRC3) \
  bitset_andn_or_cmp (DST, SRC1, SRC2, SRC3)


/* Release any memory tied up with bitsets.  */
extern void bitset_release_memory PARAMS ((void));

/* Enable bitset stats gathering.  */
extern void bitset_stats_enable PARAMS ((void));

/* Disable bitset stats gathering.  */
extern void bitset_stats_disable PARAMS ((void));

/* Read bitset stats file of accummulated stats.  */
void bitset_stats_read PARAMS ((const char *filename));

/* Write bitset stats file of accummulated stats.  */
void bitset_stats_write PARAMS ((const char *filename));

/* Dump bitset stats.  */
extern void bitset_stats_dump PARAMS ((FILE *));

/* Function to debug bitset from debugger.  */
extern void debug_bitset PARAMS ((bitset));

/* Function to debug bitset stats from debugger.  */
extern void debug_bitset_stats PARAMS ((void));

#endif /* _BITSET_H  */
Commit	Line	Data
7086e707 AD	1	/* Generic bitsets.
	2	Copyright (C) 2002 Free Software Foundation, Inc.
	3	Contributed by Michael Hayes (m.hayes@elec.canterbury.ac.nz).
	4
	5	This program is free software; you can redistribute it and/or modify
	6	it under the terms of the GNU General Public License as published by
	7	the Free Software Foundation; either version 2 of the License, or
	8	(at your option) any later version.
	9
	10	This program is distributed in the hope that it will be useful,
	11	but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	GNU General Public License for more details.
	14
	15	You should have received a copy of the GNU General Public License
	16	along with this program; if not, write to the Free Software
	17	Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
	18
	19	#ifndef _BITSET_H
04af9e52	20	#define _BITSET_H
7086e707	21
ef017502 AD	22	/* This file is the public interface to the bitset abstract data type.
ef017502 AD	23	Only use the functions and macros defined in this file. */
7086e707	24
ef017502	25	#include "bbitset.h"
7086e707 AD	26	#include "obstack.h"
7086e707 AD	27	#include <stdio.h>
7086e707	28
ef017502	29	/* Attributes used to select a bitset implementation. */
7086e707 AD	30	enum bitset_attr {BITSET_FIXED = 1, /* Bitset size fixed. */
	31	BITSET_VARIABLE = 2, /* Bitset size variable. */
	32	BITSET_DENSE = 4, /* Bitset dense. */
	33	BITSET_SPARSE = 8, /* Bitset sparse. */
	34	BITSET_FRUGAL = 16, /* Prefer most compact. */
6aa452a6	35	BITSET_GREEDY = 32}; /* Prefer fastest at memory expense. */
7086e707 AD	36
	37	typedef unsigned int bitset_attrs;
	38
47c8386f PE	39	/* The contents of the union should be considered to be private.
	40	While I would like to make this union opaque, it needs to be
	41	visible for the inline bit set/test functions, and for delegation
	42	to the proper implementation. */
	43	union bitset_union
7086e707	44	{
47c8386f PE	45	/* This must be the first member of every other structure that is a
47c8386f PE	46	member of this union. */
ef017502	47	struct bbitset_struct b;
47c8386f PE	48
	49	struct abitset_struct
	50	{
	51	struct bbitset_struct b;
	52	bitset_bindex n_bits; /* Number of bits. */
	53	bitset_word words[1]; /* The array of bits. */
	54	} a;
	55
	56	struct ebitset_struct
	57	{
	58	struct bbitset_struct b;
	59	bitset_windex size; /* Number of elements. */
	60	struct ebitset_elt_struct *elts; / Expanding array of ptrs to elts. */
	61	} e;
	62
	63	struct lbitset_struct
	64	{
	65	struct bbitset_struct b;
	66	struct lbitset_elt_struct head; / First element in linked list. */
	67	struct lbitset_elt_struct tail; / Last element in linked list. */
	68	} l;
	69
	70	struct bitset_stats_struct
	71	{
	72	struct bbitset_struct b;
	73	bitset bset;
	74	} s;
7086e707 AD	75	};
7086e707 AD	76
613f5e1a AD	77
	78	/* The contents of this structure should be considered private.
	79	It is used for iterating over set bits. */
	80	typedef struct
	81	{
	82	bitset_bindex list[BITSET_LIST_SIZE];
	83	bitset_bindex next;
808a5918 PE	84	bitset_bindex num;
808a5918 PE	85	bitset_bindex i;
613f5e1a AD	86	} bitset_iterator;
	87
	88
7086e707	89	/* Return bytes required for bitset of desired type and size. */
04af9e52	90	extern size_t bitset_bytes PARAMS ((enum bitset_type, bitset_bindex));
7086e707 AD	91
7086e707 AD	92	/* Initialise a bitset with desired type and size. */
04af9e52	93	extern bitset bitset_init PARAMS ((bitset, bitset_bindex, enum bitset_type));
7086e707	94
ef017502 AD	95	/* Select an implementation type based on the desired bitset size
ef017502 AD	96	and attributes. */
7086e707 AD	97	extern enum bitset_type bitset_type_choose PARAMS ((bitset_bindex,
	98	bitset_attrs));
	99
ef017502	100	/* Create a bitset of desired type and size. The bitset is zeroed. */
04af9e52	101	extern bitset bitset_alloc PARAMS ((bitset_bindex, enum bitset_type));
7086e707 AD	102
	103	/* Free bitset. */
	104	extern void bitset_free PARAMS ((bitset));
	105
ef017502 AD	106	/* Create a bitset of desired type and size using an obstack. The
ef017502 AD	107	bitset is zeroed. */
7086e707	108	extern bitset bitset_obstack_alloc PARAMS ((struct obstack *bobstack,
04af9e52	109	bitset_bindex, enum bitset_type));
7086e707 AD	110
	111	/* Free bitset allocated on obstack. */
	112	extern void bitset_obstack_free PARAMS ((bitset));
	113
ef017502	114	/* Create a bitset of desired size and attributes. The bitset is zeroed. */
7086e707 AD	115	extern bitset bitset_create PARAMS ((bitset_bindex, bitset_attrs));
7086e707 AD	116
613f5e1a AD	117	/* Return bitset type. */
	118	extern enum bitset_type bitset_type_get PARAMS ((bitset));
	119
6aa452a6 AD	120	/* Return bitset type name. */
	121	extern const char *bitset_type_name_get PARAMS ((bitset));
	122
7086e707 AD	123
7086e707 AD	124	/* Set bit BITNO in bitset BSET. */
04af9e52 PE	125	static inline void
04af9e52 PE	126	bitset_set (bitset bset, bitset_bindex bitno)
7086e707	127	{
dbba6a3b PE	128	bitset_windex windex = bitno / BITSET_WORD_BITS;
dbba6a3b PE	129	bitset_windex offset = windex - bset->b.cindex;
04af9e52	130
ef017502	131	if (offset < bset->b.csize)
e601ff27	132	bset->b.cdata[offset] \|= ((bitset_word) 1 << (bitno % BITSET_WORD_BITS));
7086e707	133	else
ef017502	134	BITSET_SET_ (bset, bitno);
7086e707 AD	135	}
	136
	137
	138	/* Reset bit BITNO in bitset BSET. */
04af9e52 PE	139	static inline void
04af9e52 PE	140	bitset_reset (bitset bset, bitset_bindex bitno)
7086e707	141	{
dbba6a3b PE	142	bitset_windex windex = bitno / BITSET_WORD_BITS;
dbba6a3b PE	143	bitset_windex offset = windex - bset->b.cindex;
04af9e52	144
ef017502	145	if (offset < bset->b.csize)
e601ff27	146	bset->b.cdata[offset] &= ~((bitset_word) 1 << (bitno % BITSET_WORD_BITS));
7086e707	147	else
ef017502	148	BITSET_RESET_ (bset, bitno);
7086e707 AD	149	}
	150
	151
	152	/* Test bit BITNO in bitset BSET. */
04af9e52 PE	153	static inline int
04af9e52 PE	154	bitset_test (bitset bset, bitset_bindex bitno)
7086e707	155	{
dbba6a3b PE	156	bitset_windex windex = bitno / BITSET_WORD_BITS;
dbba6a3b PE	157	bitset_windex offset = windex - bset->b.cindex;
04af9e52	158
ef017502 AD	159	if (offset < bset->b.csize)
ef017502 AD	160	return (bset->b.cdata[offset] >> (bitno % BITSET_WORD_BITS)) & 1;
7086e707	161	else
ef017502	162	return BITSET_TEST_ (bset, bitno);
7086e707	163	}
7086e707	164
7086e707	165
345cea78	166	/* Toggle bit BITNO in bitset BSET and return non-zero if now set. */
6aa452a6	167	#define bitset_toggle(bset, bitno) BITSET_TOGGLE_ (bset, bitno)
345cea78	168
6aa452a6 AD	169	/* Return size in bits of bitset SRC. */
	170	#define bitset_size(SRC) BITSET_SIZE_ (SRC)
	171
	172	/* Return number of bits set in bitset SRC. */
	173	#define bitset_count(SRC) BITSET_COUNT_ (SRC)
	174
	175
	176	/* Return SRC == 0. */
	177	#define bitset_empty_p(SRC) BITSET_EMPTY_P_ (SRC)
7086e707 AD	178
7086e707 AD	179	/* DST = ~0. */
6aa452a6	180	#define bitset_ones(DST) BITSET_ONES_ (DST)
7086e707	181
6aa452a6 AD	182	/* DST = 0. */
6aa452a6 AD	183	#define bitset_zero(DST) BITSET_ZERO_ (DST)
7086e707	184
7086e707	185
6aa452a6 AD	186
	187	/* DST = SRC. */
	188	#define bitset_copy(DST, SRC) BITSET_COPY_ (DST, SRC)
7086e707	189
ef017502	190	/* Return DST & SRC == 0. */
6aa452a6	191	#define bitset_disjoint_p(DST, SRC) BITSET_DISJOINT_P_ (DST, SRC)
ef017502	192
6aa452a6 AD	193	/* Return DST == SRC. */
6aa452a6 AD	194	#define bitset_equal_p(DST, SRC) BITSET_EQUAL_P_ (DST, SRC)
7086e707 AD	195
7086e707 AD	196	/* DST = ~SRC. */
6aa452a6 AD	197	#define bitset_not(DST, SRC) BITSET_NOT_ (DST, SRC)
	198
	199	/* Return DST == DST \| SRC. */
	200	#define bitset_subset_p(DST, SRC) BITSET_SUBSET_P_ (DST, SRC)
7086e707	201
6aa452a6 AD	202
	203
	204	/* DST = SRC1 & SRC2. */
	205	#define bitset_and(DST, SRC1, SRC2) BITSET_AND_ (DST, SRC1, SRC2)
7086e707 AD	206
7086e707 AD	207	/* DST = SRC1 & SRC2. Return non-zero if DST != SRC1 & SRC2. */
6aa452a6	208	#define bitset_and_cmp(DST, SRC1, SRC2) BITSET_AND_CMP_ (DST, SRC1, SRC2)
7086e707	209
6aa452a6 AD	210	/* DST = SRC1 & ~SRC2. */
6aa452a6 AD	211	#define bitset_andn(DST, SRC1, SRC2) BITSET_ANDN_ (DST, SRC1, SRC2)
7086e707 AD	212
7086e707 AD	213	/* DST = SRC1 & ~SRC2. Return non-zero if DST != SRC1 & ~SRC2. */
6aa452a6	214	#define bitset_andn_cmp(DST, SRC1, SRC2) BITSET_ANDN_CMP_ (DST, SRC1, SRC2)
7086e707	215
6aa452a6 AD	216	/* DST = SRC1 \| SRC2. */
	217	#define bitset_or(DST, SRC1, SRC2) BITSET_OR_ (DST, SRC1, SRC2)
	218
	219	/* DST = SRC1 \| SRC2. Return non-zero if DST != SRC1 \| SRC2. */
	220	#define bitset_or_cmp(DST, SRC1, SRC2) BITSET_OR_CMP_ (DST, SRC1, SRC2)
	221
	222	/* DST = SRC1 ^ SRC2. */
	223	#define bitset_xor(DST, SRC1, SRC2) BITSET_XOR_ (DST, SRC1, SRC2)
	224
	225	/* DST = SRC1 ^ SRC2. Return non-zero if DST != SRC1 ^ SRC2. */
	226	#define bitset_xor_cmp(DST, SRC1, SRC2) BITSET_XOR_CMP_ (DST, SRC1, SRC2)
	227
	228
	229
	230	/* DST = (SRC1 & SRC2) \| SRC3. */
	231	#define bitset_and_or(DST, SRC1, SRC2, SRC3) \
	232	BITSET_AND_OR_ (DST, SRC1, SRC2, SRC3)
7086e707 AD	233
	234	/* DST = (SRC1 & SRC2) \| SRC3. Return non-zero if
	235	DST != (SRC1 & SRC2) \| SRC3. */
6aa452a6 AD	236	#define bitset_and_or_cmp(DST, SRC1, SRC2, SRC3) \
	237	BITSET_AND_OR_CMP_ (DST, SRC1, SRC2, SRC3)
	238
	239	/* DST = (SRC1 & ~SRC2) \| SRC3. */
	240	#define bitset_andn_or(DST, SRC1, SRC2, SRC3) \
	241	BITSET_ANDN_OR_ (DST, SRC1, SRC2, SRC3)
7086e707 AD	242
	243	/* DST = (SRC1 & ~SRC2) \| SRC3. Return non-zero if
	244	DST != (SRC1 & ~SRC2) \| SRC3. */
6aa452a6 AD	245	#define bitset_andn_or_cmp(DST, SRC1, SRC2, SRC3) \
6aa452a6 AD	246	BITSET_ANDN_OR_CMP_ (DST, SRC1, SRC2, SRC3)
7086e707	247
6aa452a6 AD	248	/* DST = (SRC1 \| SRC2) & SRC3. */
	249	#define bitset_or_and(DST, SRC1, SRC2, SRC3)\
	250	BITSET_OR_AND_ (DST, SRC1, SRC2, SRC3)
7086e707	251
6aa452a6 AD	252	/* DST = (SRC1 \| SRC2) & SRC3. Return non-zero if
	253	DST != (SRC1 \| SRC2) & SRC3. */
	254	#define bitset_or_and_cmp(DST, SRC1, SRC2, SRC3)\
	255	BITSET_OR_AND_CMP_ (DST, SRC1, SRC2, SRC3)
345cea78	256
04af9e52	257	/* Find list of up to NUM bits set in BSET starting from and including
7086e707 AD	258	NEXT. Return with actual number of bits found and with NEXT
7086e707 AD	259	indicating where search stopped. */
7086e707	260	#define bitset_list(BSET, LIST, NUM, NEXT) \
04af9e52	261	BITSET_LIST_ (BSET, LIST, NUM, NEXT)
7086e707 AD	262
	263	/* Find reverse list of up to NUM bits set in BSET starting from and
	264	including NEXT. Return with actual number of bits found and with
	265	NEXT indicating where search stopped. /
6aa452a6	266	#define bitset_list_reverse(BSET, LIST, NUM, NEXT) \
04af9e52	267	BITSET_LIST_REVERSE_ (BSET, LIST, NUM, NEXT)
6aa452a6	268
7086e707	269
47c8386f PE	270	/* Find next set bit. */
	271	extern bitset_bindex bitset_next PARAMS ((bitset, bitset_bindex));
	272
	273	/* Find previous set bit. */
	274	extern bitset_bindex bitset_prev PARAMS ((bitset, bitset_bindex));
	275
7086e707	276	/* Find first set bit. */
808a5918	277	extern bitset_bindex bitset_first PARAMS ((bitset));
7086e707 AD	278
7086e707 AD	279	/* Find last set bit. */
808a5918	280	extern bitset_bindex bitset_last PARAMS ((bitset));
7086e707	281
47c8386f PE	282	/* Return nonzero if this is the only set bit. */
	283	extern int bitset_only_set_p PARAMS ((bitset, bitset_bindex));
	284
7086e707 AD	285	/* Dump bitset. */
	286	extern void bitset_dump PARAMS ((FILE *, bitset));
	287
613f5e1a	288	/* Loop over all elements of BSET, starting with MIN, setting BIT
6aa452a6 AD	289	to the index of each set bit. For example, the following will print
	290	the bits set in a bitset:
	291
	292	bitset_bindex i;
	293	bitset_iterator iter;
	294
	295	bitset_zero (dst);
	296	BITSET_FOR_EACH (iter, src, i, 0)
	297	{
	298	printf ("%ld ", i);
	299	};
	300	*/
613f5e1a AD	301	#define BITSET_FOR_EACH(ITER, BSET, BIT, MIN) \
	302	for (ITER.next = (MIN), ITER.num = BITSET_LIST_SIZE; \
	303	(ITER.num == BITSET_LIST_SIZE) \
	304	&& (ITER.num = bitset_list (BSET, ITER.list, \
04af9e52	305	BITSET_LIST_SIZE, &ITER.next));) \
613f5e1a	306	for (ITER.i = 0; (BIT) = ITER.list[ITER.i], ITER.i < ITER.num; ITER.i++)
7086e707 AD	307
	308
	309	/* Loop over all elements of BSET, in reverse order starting with
04af9e52	310	MIN, setting BIT to the index of each set bit. For example, the
6aa452a6 AD	311	following will print the bits set in a bitset in reverse order:
	312
	313	bitset_bindex i;
	314	bitset_iterator iter;
	315
	316	bitset_zero (dst);
	317	BITSET_FOR_EACH_REVERSE (iter, src, i, 0)
	318	{
	319	printf ("%ld ", i);
	320	};
	321	*/
613f5e1a AD	322	#define BITSET_FOR_EACH_REVERSE(ITER, BSET, BIT, MIN) \
	323	for (ITER.next = (MIN), ITER.num = BITSET_LIST_SIZE; \
	324	(ITER.num == BITSET_LIST_SIZE) \
	325	&& (ITER.num = bitset_list_reverse (BSET, ITER.list, \
04af9e52	326	BITSET_LIST_SIZE, &ITER.next));) \
613f5e1a	327	for (ITER.i = 0; (BIT) = ITER.list[ITER.i], ITER.i < ITER.num; ITER.i++)
7086e707 AD	328
7086e707 AD	329
ef017502	330	/* Define set operations in terms of logical operations. */
7086e707	331
04af9e52 PE	332	#define bitset_diff(DST, SRC1, SRC2) bitset_andn (DST, SRC1, SRC2)
04af9e52 PE	333	#define bitset_diff_cmp(DST, SRC1, SRC2) bitset_andn_cmp (DST, SRC1, SRC2)
7086e707	334
04af9e52 PE	335	#define bitset_intersection(DST, SRC1, SRC2) bitset_and (DST, SRC1, SRC2)
04af9e52 PE	336	#define bitset_intersection_cmp(DST, SRC1, SRC2) bitset_and_cmp (DST, SRC1, SRC2)
7086e707	337
04af9e52 PE	338	#define bitset_union(DST, SRC1, SRC2) bitset_or (DST, SRC1, SRC2)
04af9e52 PE	339	#define bitset_union_cmp(DST, SRC1, SRC2) bitset_or_cmp (DST, SRC1, SRC2)
7086e707	340
6aa452a6	341	/* Symmetrical difference. */
04af9e52 PE	342	#define bitset_symdiff(DST, SRC1, SRC2) bitset_xor (DST, SRC1, SRC2)
04af9e52 PE	343	#define bitset_symdiff_cmp(DST, SRC1, SRC2) bitset_xor_cmp (DST, SRC1, SRC2)
6aa452a6 AD	344
6aa452a6 AD	345	/* Union of difference. */
7086e707	346	#define bitset_diff_union(DST, SRC1, SRC2, SRC3) \
04af9e52	347	bitset_andn_or (DST, SRC1, SRC2, SRC3)
6aa452a6	348	#define bitset_diff_union_cmp(DST, SRC1, SRC2, SRC3) \
04af9e52	349	bitset_andn_or_cmp (DST, SRC1, SRC2, SRC3)
6aa452a6	350
ef017502	351
7086e707 AD	352
	353	/* Release any memory tied up with bitsets. */
	354	extern void bitset_release_memory PARAMS ((void));
	355
613f5e1a AD	356	/* Enable bitset stats gathering. */
	357	extern void bitset_stats_enable PARAMS ((void));
	358
	359	/* Disable bitset stats gathering. */
	360	extern void bitset_stats_disable PARAMS ((void));
	361
	362	/* Read bitset stats file of accummulated stats. */
	363	void bitset_stats_read PARAMS ((const char *filename));
	364
	365	/* Write bitset stats file of accummulated stats. */
	366	void bitset_stats_write PARAMS ((const char *filename));
7086e707 AD	367
	368	/* Dump bitset stats. */
	369	extern void bitset_stats_dump PARAMS ((FILE *));
	370
	371	/* Function to debug bitset from debugger. */
	372	extern void debug_bitset PARAMS ((bitset));
	373
	374	/* Function to debug bitset stats from debugger. */
	375	extern void debug_bitset_stats PARAMS ((void));
	376
7086e707	377	#endif /* _BITSET_H */
613f5e1a	378