typedef struct M_BitsetRec_*          M_Bitset;

handle to a ?M_BitsetRec object, used to model a given bitset

  MLIB_API(M_Bitset)   m_bitset_new( M_Memory  memory,
                                     M_Bool    push );

create a new (empty) bitset

handle to new bitset, cannot be NULL

out-of-memory

out-of-memory

  MLIB_API(M_Bitset)   m_bitset_copy( M_Bitset  source,
                                      M_Bool    push );

returns the copy of a given bitset

handle to bitset copy

out-of-memory

  MLIB_API(void)       m_bitset_destroy( M_Bitset  bitset );

destroy a given bitset (you must ensure that the bitset is not on the cleanup stack)

  MLIB_API(M_Bool)     m_bitset_is_empty( M_Bitset  bitset );

a function that returns true iff a bitset is empty (i.e. all bits to 0)

boolean

  MLIB_API(void)       m_bitset_ensure( M_Bitset  source,
                                        M_UInt    count );

reallocates a bitset block pointers table in order to ensure that it can hold at least "count" bits.

this function is used internally, and shouldn't be called directly by client applications, except in certain rare cases..

out-of-memory

  MLIB_API(M_UInt)     m_bitset_get ( M_Bitset  bitset,
                                      M_UInt    index );

return the value of a given bit in a bitset

bit value (0 or 1)

  MLIB_API(M_UInt)     m_bitset_get2( M_Bitset  bitset,
                                      M_UInt    index );

return the value of a given 2-bit cell in a bitset

cell value (0 to 3)

this functions reads the bits at [2*index..2*index+1]

  MLIB_API(M_UInt)     m_bitset_get4( M_Bitset  bitset,
                                      M_UInt    index );

return the value of a given 4-bit cell in a bitset

cell value (0 to 15)

this functions reads the bits at [4*index..4*index+3]

  MLIB_API(M_UInt)     m_bitset_get8( M_Bitset  bitset,
                                      M_UInt    index );

return the value of a given 8-bit cell in a bitset

cell value (0 to 255)

this functions reads the bits at [8*index..8*index+7]

  MLIB_API(void)       m_bitset_set ( M_Bitset   bitset,
                                      M_UInt     index,
                                      M_UInt     value );

set the value of a given bit in a bitset

out-of-memory

  MLIB_API(void)       m_bitset_set2( M_Bitset   bitset,
                                      M_UInt     index,
                                      M_UInt     value );

set the value of a given 2-bit cell in a bitset

the value is anded with 3 before being applied this function sets the bits at [2*index..2*index+1]

out-of-memory

  MLIB_API(void)       m_bitset_set4( M_Bitset   bitset,
                                      M_UInt     index,
                                      M_UInt     value );

set the value of a given 4-bit cell in a bitset

the value is anded with 15 before being applied this function sets the bits at [4*index..4*index+3]

out-of-memory

  MLIB_API(void)       m_bitset_set8( M_Bitset   bitset,
                                      M_UInt     index,
                                      M_UInt     value );

set the value of a given 8-bit cell in a bitset

the value is anded with 255 before being applied this function sets the bits at [8*index..8*index+7]

out-of-memory

  MLIB_API(void)       m_bitset_set_range( M_Bitset  bitset,
                                           M_UInt    start,
                                           M_UInt    count,
                                           M_UInt    size,
                                           M_UInt    value );

this function is used to set a range of bit cells to a single value.

this function will panic if "size" is not 1, 2, 4 or 8

the value is anded with (1 << size)-1 before being applied this function sets the bits at [size*index..size*index+size-1]

out-of-memory

  MLIB_API(M_Bool)     m_bitset_test_intersect( M_Bitset  bitset1,
                                                M_Bitset  bitset2 );

returns true iff two bitsets intersect

this function is a quick way to test if two bitsets intersect. however, if you need the intersection itself, consider using m_bitset_intersect directly..

  MLIB_API(void)       m_bitset_clear( M_Bitset  bitset );

clear a bitset, i.e. set all bits/cells to 0

  MLIB_API(M_Bitset)   m_bitset_union( M_Bitset  bitset1,
                                       M_Bitset  bitset2,
                                       M_Bool    push );

computes the union of two bitsets

union of the two bitsets

out-of-memory

  MLIB_API(M_Bitset)   m_bitset_intersect( M_Bitset  bitset1,
                                           M_Bitset  bitset2,
                                           M_Bool    push );

computes the intersection of two bitsets

intersection of the two bitsets

out-of-memory

  MLIB_API(M_Bitset)   m_bitset_substract( M_Bitset  bitset1,
                                           M_Bitset  bitset2,
                                           M_Bool    push );

computes the substraction of two bitsets

bitset1 - bitset2

out-of-memory

  MLIB_API(void)       m_bitset_compress( M_Bitset  bitset );

compress a given bitset in memory.

  MLIB_API(void)       m_bitset_push( M_Bitset  set );

push a given bitset on the cleanup stack

  MLIB_API(void)       m_bitset_pop( M_Bitset  bitset,
                                     M_Bool    keep_it );

pops a given bitset from the cleanup stack