Trait oxygengine_core::ecs::hibitset::BitSetLike

pub trait BitSetLike {
    pub fn layer3(&self) -> usize;
    pub fn layer2(&self, i: usize) -> usize;
    pub fn layer1(&self, i: usize) -> usize;
    pub fn layer0(&self, i: usize) -> usize;
    pub fn contains(&self, i: u32) -> bool;

    pub fn get_from_layer(&self, layer: usize, idx: usize) -> usize { ... }
    pub fn is_empty(&self) -> bool { ... }
    pub fn iter(self) -> BitIter<Self> { ... }
}

A generic interface for BitSetLike-like types.

Every BitSetLike is hierarchical, meaning that there are multiple levels that branch out in a tree like structure.

Layer0 each bit represents one Index of the set Layer1 each bit represents one usize of Layer0, and will be set only if the word below it is not zero. Layer2 has the same arrangement but with Layer1, and Layer3 with Layer2.

This arrangement allows for rapid jumps across the key-space.

Required methods

pub fn layer3(&self) -> usize

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

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

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

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

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

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

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

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

Allows checking if set bit is contained in the bit set.

Loading content...

Provided methods

pub fn get_from_layer(&self, layer: usize, idx: usize) -> usize

Gets the usize corresponding to layer and index.

The layer should be in the range [0, 3]

pub fn is_empty(&self) -> bool

Returns true if this BitSetLike contains nothing, and false otherwise.

pub fn iter(self) -> BitIter<Self>

Create an iterator that will scan over the keyspace

Loading content...

Trait Implementations

impl<'a> Join for &'a (dyn BitSetLike + 'a)

type Type = u32

Type of joined components.

type Value = ()

Type of joined storages.

type Mask = &'a (dyn BitSetLike + 'a)

Type of joined bit mask.

pub unsafe fn open(
    self
) -> (<&'a (dyn BitSetLike + 'a) as Join>::Mask, <&'a (dyn BitSetLike + 'a) as Join>::Value)

Open this join by returning the mask and the storages.

pub unsafe fn get(
    &mut <&'a (dyn BitSetLike + 'a) as Join>::Value,
    id: u32
) -> <&'a (dyn BitSetLike + 'a) as Join>::Type

Get a joined component value by a given index.

pub fn join(self) -> JoinIter<Self>

Create a joined iterator over the contents.

pub fn maybe(self) -> MaybeJoin<Self>

Returns a Join-able structure that yields all indices, returning None for all missing elements and Some(T) for found elements.

pub fn is_unconstrained() -> bool

If this Join typically returns all indices in the mask, then iterating over only it or combined with other joins that are also dangerous will cause the JoinIter/ParJoin to go through all indices which is usually not what is wanted and will kill performance.

Implementations on Foreign Types

impl<'a, T> BitSetLike for &'a T where
    T: BitSetLike + ?Sized, 

pub fn layer3(&self) -> usize

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

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

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

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

impl<'a, T> BitSetLike for &'a mut T where
    T: BitSetLike + ?Sized, 

pub fn layer3(&self) -> usize

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

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

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

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

Loading content...

Implementors

impl BitSetLike for BitSet

pub fn layer3(&self) -> usize

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

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

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

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

impl BitSetLike for AtomicBitSet

pub fn layer3(&self) -> usize

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

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

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

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

impl BitSetLike for BitSetAll

pub fn layer3(&self) -> usize

pub fn layer2(&self, _id: usize) -> usize

pub fn layer1(&self, _id: usize) -> usize

pub fn layer0(&self, _id: usize) -> usize

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

impl<A> BitSetLike for BitSetNot<A> where
    A: BitSetLike, 

pub fn layer3(&self) -> usize

pub fn layer2(&self, usize) -> usize

pub fn layer1(&self, usize) -> usize

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

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

impl<A, B> BitSetLike for BitSetAnd<A, B> where
    A: BitSetLike,
    B: BitSetLike, 

pub fn layer3(&self) -> usize

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

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

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

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

impl<A, B> BitSetLike for BitSetOr<A, B> where
    A: BitSetLike,
    B: BitSetLike, 

pub fn layer3(&self) -> usize

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

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

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

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

impl<A, B> BitSetLike for BitSetXor<A, B> where
    A: BitSetLike,
    B: BitSetLike, 

pub fn layer3(&self) -> usize

pub fn layer2(&self, id: usize) -> usize

pub fn layer1(&self, id: usize) -> usize

pub fn layer0(&self, id: usize) -> usize

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

Loading content...