Struct Index

pub struct Index<LevelMask: BitBlock, LevelCount: ConstInteger>(/* private fields */);

Range checked index.

Known to be within HibitTree<LevelMaskType, LevelCount>::index_range().

Whenever you see impl Into<Index<_, _>> - you can just use your usize index as usual.

Index range check is very cheap, and is just one assert_eq with constant value. But in tight loops you may want to get rid of that check - and that’s the sole purpose of Index.

// use it just as usize
array.get(12);

// zero-cost unsafe construction
array.get(unsafe{ Index::new_unchecked(12) });

// safe construct once, then reuse
{
    let i = Index::from(12);
    array.get(i);
    array2.get(i);
}

Implementations

impl<LevelMaskType: BitBlock, LevelCount: ConstInteger> Index<LevelMaskType, LevelCount>

pub unsafe fn new_unchecked(index: usize) -> Self

Safety

You must guarantee that index is in SparseHierarchy<LevelMaskType, LevelCount> range.

Trait Implementations

impl<LevelMask: BitBlock, LevelCount: ConstInteger> Clone for Index<LevelMask, LevelCount>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<LevelMaskType: BitBlock, LevelCount: ConstInteger> From<Index<LevelMaskType, LevelCount>> for usize

SparseHierarchyIndex -> usize

fn from(value: Index<LevelMaskType, LevelCount>) -> Self

Converts to this type from the input type.

impl<LevelMaskType: BitBlock, LevelCount: ConstInteger> From<usize> for Index<LevelMaskType, LevelCount>

usize -> SparseHierarchyIndex

fn from(index: usize) -> Self

Panic

Panics if index is not in SparseHierarchy<LevelMaskType, LevelCount> range.

impl<LevelMask: BitBlock, LevelCount: ConstInteger> Copy for Index<LevelMask, LevelCount>