Trait oxygengine::core::ecs::hibitset::BitSetLike

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

    fn get_from_layer(&self, layer: usize, idx: usize) -> usize { ... }
    fn is_empty(&self) -> bool { ... }
    fn iter(self) -> BitIter<Self>ⓘ
Important traits for BitIter<T>
impl<T> Iterator for BitIter<T> where
    T: BitSetLike,     type Item = u32; { ... }
}

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

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 contains(&self, i: u32) -> bool

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

Loading content...

Provided methods

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]

fn is_empty(&self) -> bool

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

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

Important traits for BitIter<T>

impl<T> Iterator for BitIter<T> where
    T: BitSetLike,  type Item = u32;

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.

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.

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.

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

Important traits for JoinIter<J>

impl<J> Iterator for JoinIter<J> where
    J: Join,  type Item = <J as Join>::Type;

Create a joined iterator over the contents.

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.

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 mut T where
    T: BitSetLike + ?Sized, 

fn layer3(&self) -> usize

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

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

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

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

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

fn layer3(&self) -> usize

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

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

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

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

Loading content...

Implementors

impl BitSetLike for AtomicBitSet

fn layer3(&self) -> usize

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

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

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

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

impl BitSetLike for BitSetAll

fn layer3(&self) -> usize

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

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

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

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

impl BitSetLike for BitSet

fn layer3(&self) -> usize

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

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

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

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

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

fn layer3(&self) -> usize

fn layer2(&self, usize) -> usize

fn layer1(&self, usize) -> usize

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

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

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

fn layer3(&self) -> usize

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

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

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

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

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

fn layer3(&self) -> usize

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

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

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

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

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

fn layer3(&self) -> usize

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

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

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

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

Loading content...