/home/tom/src/ogc-dev/trunk/nm/frameworks/src/include/nm/nm_bv.h

/*
 * Copyright (c) 2008 Open Grid Computing, Inc.
 * All rights reserved.
 *
 * Confidential and Proprietary
 */
#ifndef __NM_BV_H
#define __NM_BV_H

#include <stdlib.h>
#include <string.h>
#include <nm/nm.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct nm_bv {
        int count;              
        int set_count;          
        nm_u32_t *bitvec;
} nm_bv_t;

typedef struct nm_bv_iter {
        int next_idx;
        int next_bit;
} nm_bv_iter_t;

/* If the user allocates a bitvector with a count of 0 (growable), the
 * default count is 32 */
#define NM_BV_DEF_COUNT 32

/* This is the number of bits to shift the count to get the size in
 * bytes of the u32 array needed to store the bits. It is a quick way
 * to compute count / (32b per word) * (4B per word) */
#define NM_BV_SZ_SHIFT 3

/* This is the number of bits to shift the bit# to get the containing
 * u32. It is count / 32. */
#define NM_BV_IDX_SHIFT 5

/* Number of bits in a single IDX element */
#define NM_BV_IBITS (32)

/* This is the mask needed to convert bv bit number to the containing
 * u32 bit number. */
#define NM_BV_IBIT_MASK (NM_BV_IBITS-1)

/* Static initializer */
#define NM_BV_INITIALIZER { 0 }

static inline int nm_bv_bits_to_words(int bits)
{
        return nm_roundup2(bits, NM_BV_IBITS) >> NM_BV_IDX_SHIFT;
}

static inline void nm_bv_init(nm_bv_t *bv)
{
        bv->count = bv->set_count = 0;
        bv->bitvec = NULL;
}

extern void nm_bv_free(nm_bv_t *bv);

extern int nm_bv_copy(nm_bv_t *dst, nm_bv_t *src);

extern int nm_bv_set(nm_bv_t *bv, int bit);

extern int nm_bv_set_count(nm_bv_t *bv);

extern int nm_bv_reset(nm_bv_t *bv, int bit);

extern int nm_bv_test(nm_bv_t *bv, int bit);

extern int nm_bv_first(nm_bv_t *bv, nm_bv_iter_t *iter);

extern int nm_bv_next(nm_bv_t *bv, nm_bv_iter_t *iter);

extern int nm_sz_to_bv(const char *sz, nm_bv_t *bv,
                       const char *rangesep, const char *sep);
extern int nm_bv_to_sz(nm_bv_t *bv, char *sz, int maxlen,
                       const char *rangesep, const char *sep);

#ifdef __cplusplus
}
#endif

#endif

---