Struct Bitmap

pub struct Bitmap<Size: Bits> { /* private fields */ }

A compact array of bits.

The type used to store the bitmap will be the minimum unsigned integer type required to fit the number of bits, from u8 to u128. If the size is 1, bool is used. If the size exceeds 128, an array of u128 will be used, sized as appropriately. The maximum supported size is currently 1024, represented by an array [u128; 8].

Implementations

impl Bitmap<U128>

pub unsafe fn load_m128i(&self) -> __m128i

Available with target feature sse2 only.

impl Bitmap<U256>

pub unsafe fn load_m128i(&self) -> [__m128i; 2]

Available with target feature sse2 only.

pub unsafe fn load_m256i(&self) -> __m256i

Available with target feature avx only.

impl Bitmap<U512>

pub unsafe fn load_m128i(&self) -> [__m128i; 4]

Available with target feature sse2 only.

pub unsafe fn load_m256i(&self) -> [__m256i; 2]

Available with target feature avx only.

impl Bitmap<U768>

pub unsafe fn load_m128i(&self) -> [__m128i; 6]

Available with target feature sse2 only.

pub unsafe fn load_m256i(&self) -> [__m256i; 3]

Available with target feature avx only.

impl Bitmap<U1024>

pub unsafe fn load_m128i(&self) -> [__m128i; 8]

Available with target feature sse2 only.

pub unsafe fn load_m256i(&self) -> [__m256i; 4]

Available with target feature avx only.

impl<Size: Bits> Bitmap<Size>

pub fn new() -> Self

Construct a bitmap with every bit set to false.

pub fn mask(bits: usize) -> Self

Construct a bitmap where every bit with index less than bits is true, and every other bit is false.

pub fn from_value(data: Size::Store) -> Self

Construct a bitmap from a value of the same type as its backing store.

pub fn into_value(self) -> Size::Store

Convert this bitmap into a value of the type of its backing store.

pub fn len(self) -> usize

Count the number of true bits in the bitmap.

pub fn is_empty(self) -> bool

Test if the bitmap contains only false bits.

pub fn get(self, index: usize) -> bool

Get the value of the bit at a given index.

pub fn set(&mut self, index: usize, value: bool) -> bool

Set the value of the bit at a given index.

Returns the previous value of the bit.

pub fn first_index(self) -> Option<usize>

Find the index of the first true bit in the bitmap.

pub fn invert(&mut self)

Invert all the bits in the bitmap.

Trait Implementations

impl<Size: Bits> BitAnd for Bitmap<Size>

type Output = Bitmap<Size>

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl<Size: Bits> BitAndAssign for Bitmap<Size>

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl<Size: Bits> BitOr for Bitmap<Size>

type Output = Bitmap<Size>

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl<Size: Bits> BitOrAssign for Bitmap<Size>

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl<Size: Bits> BitXor for Bitmap<Size>

type Output = Bitmap<Size>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl<Size: Bits> BitXorAssign for Bitmap<Size>

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl<Size: Bits> Clone for Bitmap<Size>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Size: Bits> Debug for Bitmap<Size>

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<Size: Bits> Default for Bitmap<Size>

fn default() -> Self

Returns the “default value” for a type.

impl From<[u128; 2]> for Bitmap<U256>

fn from(data: [u128; 2]) -> Self

Converts to this type from the input type.

impl From<[u128; 3]> for Bitmap<U384>

fn from(data: [u128; 3]) -> Self

Converts to this type from the input type.

impl From<[u128; 4]> for Bitmap<U512>

fn from(data: [u128; 4]) -> Self

Converts to this type from the input type.

impl From<[u128; 5]> for Bitmap<U640>

fn from(data: [u128; 5]) -> Self

Converts to this type from the input type.

impl From<[u128; 6]> for Bitmap<U768>

fn from(data: [u128; 6]) -> Self

Converts to this type from the input type.

impl From<[u128; 7]> for Bitmap<U896>

fn from(data: [u128; 7]) -> Self

Converts to this type from the input type.

impl From<[u128; 8]> for Bitmap<U1024>

fn from(data: [u128; 8]) -> Self

Converts to this type from the input type.

impl From<__m128i> for Bitmap<U128>

fn from(data: __m128i) -> Self

Converts to this type from the input type.

impl From<__m256i> for Bitmap<U256>

fn from(data: __m256i) -> Self

Converts to this type from the input type.

impl Into<[u128; 2]> for Bitmap<U256>

fn into(self) -> [u128; 2]

Converts this type into the (usually inferred) input type.

impl Into<[u128; 3]> for Bitmap<U384>

fn into(self) -> [u128; 3]

Converts this type into the (usually inferred) input type.

impl Into<[u128; 4]> for Bitmap<U512>

fn into(self) -> [u128; 4]

Converts this type into the (usually inferred) input type.

impl Into<[u128; 5]> for Bitmap<U640>

fn into(self) -> [u128; 5]

Converts this type into the (usually inferred) input type.

impl Into<[u128; 6]> for Bitmap<U768>

fn into(self) -> [u128; 6]

Converts this type into the (usually inferred) input type.

impl Into<[u128; 7]> for Bitmap<U896>

fn into(self) -> [u128; 7]

Converts this type into the (usually inferred) input type.

impl Into<[u128; 8]> for Bitmap<U1024>

fn into(self) -> [u128; 8]

Converts this type into the (usually inferred) input type.

impl Into<__m128i> for Bitmap<U128>

fn into(self) -> __m128i

Converts this type into the (usually inferred) input type.

impl Into<__m256i> for Bitmap<U256>

fn into(self) -> __m256i

Converts this type into the (usually inferred) input type.

impl<'a, Size: Bits> IntoIterator for &'a Bitmap<Size>

type Item = usize

The type of the elements being iterated over.

type IntoIter = Iter<'a, Size>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<Size: Bits> Not for Bitmap<Size>

type Output = Bitmap<Size>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<Size: Bits> PartialEq for Bitmap<Size>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Size: Bits> Copy for Bitmap<Size>