> For the complete documentation index, see [llms.txt](https://docs.interestprotocol.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.interestprotocol.com/overview/deprecated/sui-tears/collections/bitmap.md).

# Bitmap

BitMaps pack 256 booleans across each bit of a single 256-bit slot of `uint256` type. Hence booleans corresponding to 256 *sequential* indices would only consume a single slot, unlike the regular `bool` which would consume an entire slot for a single value.

## Structs

### <mark style="color:blue;">**Bitmap**</mark>

```rust
struct Bitmap has key, store {
    id: UID
}
```

The module adds dynamic fields to the Bitmap.&#x20;

## Interface

### <mark style="color:blue;">new</mark>

**Creates a Bitmap.**

```rust
public fun new(ctx: &mut TxContext): Bitmap
```

* **@return AcCollection.** Bitmap.

### <mark style="color:blue;">get</mark>

**Checks if an `index`is set to true or false in the map.**

```rust
public fun get(self: &Bitmap, index: u256): bool
```

* **@param self:** A reference to the Bitmap.
* **@param index:** The slot to check if it is flagged.
* **@return bool.** If the `index` is true or false.

### <mark style="color:blue;">set</mark>

**Sets the slot `index` to true in `self`.**

```rust
public fun set(self: &mut Bitmap, index: u256)
```

* **@param self:** A reference to the Bitmap.
* **@param index**: The slot we will set to true.

### <mark style="color:blue;">unset</mark>

**Sets the slot `index` to false in `self`.**

```rust
public fun set(self: &mut Bitmap, index: u256)
```

* **@param self:** A reference to the Bitmap.
* **@param index**: The slot we will set to false.

### <mark style="color:blue;">destroy</mark>

**Destroys the `self`.**

```rust
public fun destroy(self: Bitmap)
```

* **@param self:** self A bitmap to destroy.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.interestprotocol.com/overview/deprecated/sui-tears/collections/bitmap.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.