Struct SparseSet

pub struct SparseSet<S> { /* private fields */ }

Two-dimensional storage containing heterogeneous data types based on AnyVec.

This struct is composed of “Sparse” and “Dense” layers. Sparse layer is literally sparse, so it can contain vacant slots in it, while dense layer doesn’t. Dense layer contains real items and the items can be accessed through the sparse layer. Each dense is identified by its item’s TypeId. But you are encouraged to access each dense by its index, not TypeId for the performance.

We call each dense layer a column, and all columns have the same length. So it looks like a 2D matrix as shown below.

Index  Sparse  Dense  Dense
                 A      B
  0      0 _____ .      .
  1      2 _   _ .      .
  2      x  \_/_ .      .
  3      1 __/   

, where '.' is item and 'x' is vacant slot.

Implementations

impl<S> SparseSet<S>

where S: Default,

pub fn new() -> Self

Creates a new empty SparseSet.

Examples

let mut cont = SparseSet::<std::hash::RandomState>::new();

Trait Implementations

impl<S> AddEntity for SparseSet<S>

where S: BuildHasher + Default + Clone + 'static,

fn to_value_index(&self, ri: usize) -> Option<usize>

Converts given row index to value index.

fn begin_add_row(&mut self)

Starts inserting component values of an entity to the entity container.

unsafe fn add_value(&mut self, ci: usize, val_ptr: NonNull<u8>)

Inserts a component value of an entity in the entity container.

unsafe fn end_add_row(&mut self) -> usize

Finishes inserting component values of an entity in the entity container then returns row index to the inserted entity.

fn value_ptr_by_value_index(&self, ci: usize, vi: usize) -> Option<NonNull<u8>>

Retrieves a pointer to a component value for the given column and value indices.

fn remove_row(&mut self, ri: usize) -> bool

Removes an entity for the given row index from the entity container.

fn remove_row_by_value_index(&mut self, vi: usize)

Removes an entity for the given value index from the entity container.

unsafe fn begin_remove_row_by_value_index(&mut self, vi: usize)

Starts removing component values of an entity from the entity container.

unsafe fn remove_value_by_value_index( &mut self, ci: usize, vi: usize, buf: NonNull<u8>, )

Removes a component value of an entity in the entity container then write it to the given buffer.

unsafe fn drop_value_by_value_index(&mut self, ci: usize, vi: usize)

Drops a component value of an entity in the entity container.

unsafe fn forget_value_by_value_index(&mut self, ci: usize, vi: usize)

Removes and forgets a component value of an entity in the entity container.

unsafe fn end_remove_row_by_value_index(&mut self, vi: usize)

Finishes removing component values of an entity in the entity container.

impl<S> BorrowComponent for SparseSet<S>

where S: BuildHasher + Default + Clone + 'static,

fn borrow_column(&self, ci: usize) -> BorrowResult<RawGetter>

Borrows component column for the given column index.

fn borrow_column_mut(&mut self, ci: usize) -> BorrowResult<RawGetter>

Borrows component column mutably for the given column index.

unsafe fn get_column(&self, ci: usize) -> Option<NonNull<u8>>

Retrieves component column pointer for the given column index.

impl<S> ContainEntity for SparseSet<S>

where S: BuildHasher + Default + Clone + 'static,

fn create_twin(&self) -> Box<dyn ContainEntity>

Creates a new entity container that has the same component types without component values.

fn get_item_mut(&mut self, ci: usize, ri: usize) -> Option<NonNull<u8>>

Retrieves an entity for the given component column index and row index from the entity container.

fn len(&self) -> usize

Returns number of entities in the entity container.

fn capacity(&self) -> usize

Returns capacity of the entity container.

fn reserve(&mut self, additional: usize)

May reserve at least additional extra capacity.

fn shrink_to_fit(&mut self)

May shrink capacity of the entity container as much as possible.

unsafe fn resize_column( &mut self, ci: usize, new_len: usize, val_ptr: NonNull<u8>, )

Panics

impl<S: Debug> Debug for SparseSet<S>

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

Formats the value using the given formatter.

impl<S> Default for SparseSet<S>

where S: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<S> RegisterComponent for SparseSet<S>

where S: BuildHasher + Default + Clone + 'static,

fn add_column(&mut self, tinfo: TypeInfo) -> Option<usize>

Adds a component column to the entity container then returns column index.

fn remove_column(&mut self, ci: usize) -> Option<TypeInfo>

Removes the component column from the entity container.

fn get_column_index(&self, ty: &TypeId) -> Option<usize>

Retrieves column index for the given component type.

fn get_column_info(&self, ci: usize) -> Option<&TypeInfo>

Retrieves TypeInfo of the component for the given column index.

fn num_columns(&self) -> usize

Retrieves number of component columns in the entity container.

fn contains_column(&self, ty: &TypeId) -> bool

Returns true if the entity container contains given component type.