Struct hibitset::BitSet

pub struct BitSet { /* fields omitted */ }

A BitSet is a simple set designed to track entity indices for which a certain component exists. It does not track the Generation of the entities that it contains.

Note, a BitSet is limited by design to only 1,048,576 indices. Adding beyond this limit will cause the BitSet to panic.

Methods

impl BitSet

fn new() -> BitSet

Creates an empty BitSet.

fn with_capacity(max: u32) -> BitSet

Creates an empty BitSet, preallocated for up to max indices.

fn add(&mut self, id: u32) -> bool

Adds id to the BitSet. Returns true if the value was already in the set.

fn remove(&mut self, id: u32) -> bool

Removes id from the set, returns true if the value was removed, and false if the value was not set to begin with.

fn contains(&self, id: u32) -> bool

Returns true if id is in the set.

fn clear(&mut self)

Completely wipes out the bit set.

Trait Implementations

impl Not for BitSet

type Output = BitSetNot<Self>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<T> BitAnd<T> for BitSet where
    T: BitSetLike, 

type Output = BitSetAnd<Self, T>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<T> BitOr<T> for BitSet where
    T: BitSetLike, 

type Output = BitSetOr<Self, T>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<T> BitXor<T> for BitSet where
    T: BitSetLike, 

type Output = BitSetXor<Self, T>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<'a> Not for &'a BitSet

type Output = BitSetNot<Self>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<'a, T> BitAnd<T> for &'a BitSet where
    T: BitSetLike, 

type Output = BitSetAnd<Self, T>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<'a, T> BitOr<T> for &'a BitSet where
    T: BitSetLike, 

type Output = BitSetOr<Self, T>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<'a, T> BitXor<T> for &'a BitSet where
    T: BitSetLike, 

type Output = BitSetXor<Self, T>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl Clone for BitSet

fn clone(&self) -> BitSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BitSet

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for BitSet

fn default() -> BitSet

Returns the "default value" for a type.

impl BitSetLike for BitSet

fn layer3(&self) -> usize

Return a usize where each bit represents if any word in layer2 has been set.

fn layer2(&self, i: usize) -> usize

Return the usize from the array of usizes that indicates if any bit has been set in layer1

fn layer1(&self, i: usize) -> usize

Return the usize from the array of usizes that indicates if any bit has been set in layer0

fn layer0(&self, i: usize) -> usize

Return a usize that maps to the direct 1:1 association with each index of the set

fn iter(self) -> BitIter<Self> where
    Self: Sized, 

Create an iterator that will scan over the keyspace

fn par_iter(self) -> BitParIter<Self> where
    Self: Sized, 

Create a parallel iterator that will scan over the keyspace