https://github.com/wanji/bitmap

BitMap class
https://github.com/wanji/bitmap

Last synced: 15 days ago
JSON representation

BitMap class

• Host: GitHub
• URL: https://github.com/wanji/bitmap
• Owner: wanji
• License: mit
• Created: 2015-02-04T04:59:42.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2022-05-14T14:34:20.000Z (over 2 years ago)
• Last Synced: 2024-09-15T22:53:12.787Z (about 2 months ago)
• Language: Python
• Size: 10.7 KB
• Stars: 42
• Watchers: 2
• Forks: 18
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
BitMap for python

=================

This package provides a `BitMap` class which is an array of bits stored in compact format.

# Installation

`bitmap` can be installed from `pip`:

```bash

$ sudo pip install bitmap

```

# Functions

- `BitMap(maxnum)`: construct a `BitMap` object with `maxnum` bits

- `set(pos)`: set the bit at position `pos` to 1

- `reset(pos)`: reset the bit at position `pos` to 0

- `flip(pos)`: flip the bit at position `pos`

- `count()`: return the number of 1s

- `size()`: return the size of the `BitMap`

- `test(pos)`: check if bit at position `pos` has been set to 1

- `any()`: check if any bit in the `BitMap` has been set to 1

- `none()`: check if none of the bits in the `BitMap` has been set to 1

- `all()`: check if all bits in the `BitMap` has been set to 1

- `nonzero()`: return indexes of all non-zero bits

- `tostring()`: convert a `BitMap` object to `0` and `1` string

- `fromstring(bitstring)`: create a `BitMap` object from `0` and `1` string

# Examples

```python

from bitmap import BitMap

bm = BitMap(32)

print bm.tostring()

bm.set(1)

print bm.tostring()

bm = BitMap.fromstring("00011101")

print bm.tostring()

bm.flip(1)

print bm.tostring()

```