/* $Id: petscbt.h,v 1.22 2001/09/07 20:13:16 bsmith Exp $ */

/*    

          BT - Bit array objects: used to compactly store logical arrays of variables.

     PetscBTCreate(m,bt)        - creates a bit array with enough room to hold m values
     PetscBTDestroy(bt)         - destroys the bit array
     PetscBTMemzero(m,bt)       - zeros the entire bit array (sets all values to false)
     PetscBTSet(bt,index)       - sets a particular entry as true
     PetscBTClear(bt,index)     - sets a particular entry as false
     PetscBTLookup(bt,index)    - returns the value 
     PetscBTLookupSet(bt,index) - returns the value and then sets it true
     PetscBTLength(m)           - returns number of bytes in array with m bits
     PetscBTView(m,bt,viewer)   - prints all the entries in a bit array

    These routines do not currently have manual pages.

    The are all implemented as macros with the trivial data structure for efficiency.

    These are not thread safe since they use a few global variables.

    We do not currently check error flags on PetscBTSet(), PetscBTClear(), PetscBTLookup(),
    PetcBTLookupSet(), PetscBTLength() cause error checking would cost hundreds more cycles then
    the operation.

*/
#if !defined(__PETSCBT_H)
#define __PETSCBT_H

/*S
     PetscBT - PETSc bitarrays

   Level: advanced

   Notes: the PetscBT routines do not currently have manual pages. See include/petscbt.h for 
          documentation

.seealso:  PetscBTCreate(), PetscBTDestroy(), PetscBTMemzero(), PetscBTSet(), PetscBTClear(),
           PetscBTLookup(), PetscBTLookupSet(), PetscBTLength(), PetscBTView()
S*/
typedef char* PetscBT;

extern char _BT_mask,_BT_c;
extern int  _BT_idx;

#define PetscBTLength(m)        ((m)/PETSC_BITS_PER_BYTE+1)*sizeof(char)
#define PetscBTMemzero(m,array) PetscMemzero(array,(m)/PETSC_BITS_PER_BYTE+1)
#define PetscBTDestroy(array)   PetscFree(array)

#define PetscBTView(m,bt,viewer) 0; {\
  int    __i,_8_ierr; \
  PetscViewer __viewer = viewer; \
  if (!__viewer) __viewer = PETSC_VIEWER_STDOUT_SELF;\
  for (__i=0; __i<m; __i++) { \
    _8_ierr = PetscPrintf(((PetscObject)__viewer)->comm,"%d %d\n",__i,PetscBTLookup(bt,__i));CHKERRQ(_8_ierr);\
  }}

#define PetscBTCreate(m,array)  0; { \
  int _9_ierr; \
  _9_ierr = PetscMalloc(((m)/PETSC_BITS_PER_BYTE+1)*sizeof(char),&(array));CHKERRQ(_9_ierr);\
  _9_ierr = PetscBTMemzero(m,array);CHKERRQ(_9_ierr);\
  }

#define PetscBTLookupSet(array,index)   (_BT_idx           = (index)/PETSC_BITS_PER_BYTE, \
                                        _BT_c           = array[_BT_idx], \
                                        _BT_mask        = (char)1 << ((index)%PETSC_BITS_PER_BYTE), \
                                        array[_BT_idx]  = _BT_c | _BT_mask, \
                                        _BT_c & _BT_mask)

#define PetscBTSet(array,index)         (_BT_idx          = (index)/PETSC_BITS_PER_BYTE, \
                                        _BT_c           = array[_BT_idx], \
                                        _BT_mask        = (char)1 << ((index)%PETSC_BITS_PER_BYTE), \
                                        array[_BT_idx]  = _BT_c | _BT_mask,0)


#define PetscBTClear(array,index)  (_BT_idx          = (index)/PETSC_BITS_PER_BYTE, \
                                   _BT_c           = array[_BT_idx], \
                                   _BT_mask        = (char)1 << ((index)%PETSC_BITS_PER_BYTE), \
                                   array[_BT_idx]  = _BT_c & (~_BT_mask),0)

#define PetscBTLookup(array,index) (_BT_idx          = (index)/PETSC_BITS_PER_BYTE, \
                                   _BT_c           = array[_BT_idx], \
                                   _BT_mask        = (char)1 << ((index)%PETSC_BITS_PER_BYTE), \
                                   (_BT_c & _BT_mask) != 0)

#endif