Skip to content

feat(vector): add index operations without bounds checks #963

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vapourismo merged 1 commit into from
Mar 30, 2026
Merged

feat(vector): add index operations without bounds checks #963

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions data/src/components/vector.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,26 @@ impl<T, M: VectorMode> Vector<T, M> {
) -> Result<(), E> {
M::try_resize_with(self, new_len, new_value)
}

/// Perform an [`Self::index`] operation without a bounds check.
///
/// # Safety
///
/// The caller must ensure that the provided index is within the vector's bounds.
#[inline(always)]
pub unsafe fn index_unchecked(&self, idx: usize) -> &T {
unsafe { M::index_unchecked(self, idx) }
}

/// Perform an [`Self::index_mut`] operation without a bounds check.
///
/// # Safety
///
/// The caller must ensure that the provided index is within the vector's bounds.
#[inline(always)]
pub unsafe fn index_unchecked_mut(&mut self, idx: usize) -> &mut T {
unsafe { M::index_unchecked_mut(self, idx) }
}
}

impl<T> Vector<T, Normal> {
Expand Down Expand Up @@ -381,6 +401,20 @@ pub trait VectorMode: Mode {
/// See [`Vector::index`].
fn index<T>(this: &Vector<T, Self>, idx: usize) -> &T;

/// See [`Vector::index_unchecked`].
///
/// # Safety
///
/// See notice in [`Vector::index_unchecked`].
unsafe fn index_unchecked<T>(this: &Vector<T, Self>, idx: usize) -> &T;

/// See [`Vector::index_unchecked_mut`].
///
/// # Safety
///
/// See notice in [`Vector::index_unchecked_mut`].
unsafe fn index_unchecked_mut<T>(this: &mut Vector<T, Self>, idx: usize) -> &mut T;

/// See [`Vector::index_mut`].
fn index_mut<T>(this: &mut Vector<T, Self>, idx: usize) -> &mut T;

Expand All @@ -404,6 +438,16 @@ impl VectorMode for Normal {
&this.vector[idx]
}

#[inline(always)]
unsafe fn index_unchecked<T>(this: &Vector<T, Self>, idx: usize) -> &T {
unsafe { this.vector.get_unchecked(idx) }
}

#[inline(always)]
unsafe fn index_unchecked_mut<T>(this: &mut Vector<T, Self>, idx: usize) -> &mut T {
unsafe { this.vector.get_unchecked_mut(idx) }
}

fn index_mut<T>(this: &mut Vector<T, Self>, idx: usize) -> &mut T {
&mut this.vector[idx]
}
Expand Down Expand Up @@ -459,6 +503,14 @@ impl VectorMode for Prove<'_> {
}
}

unsafe fn index_unchecked<T>(this: &Vector<T, Self>, idx: usize) -> &T {
Self::index(this, idx)
}

unsafe fn index_unchecked_mut<T>(this: &mut Vector<T, Self>, idx: usize) -> &mut T {
Self::index_mut(this, idx)
}

fn index_mut<T>(this: &mut Vector<T, Self>, idx: usize) -> &mut T {
this.vector.record_access(idx);

Expand Down Expand Up @@ -534,6 +586,14 @@ impl VectorMode for Verify {
}
}

unsafe fn index_unchecked<T>(this: &Vector<T, Self>, idx: usize) -> &T {
Self::index(this, idx)
}

unsafe fn index_unchecked_mut<T>(this: &mut Vector<T, Self>, idx: usize) -> &mut T {
Self::index_mut(this, idx)
}

fn index_mut<T>(this: &mut Vector<T, Self>, idx: usize) -> &mut T {
match this.vector.items.get_mut(idx) {
Some(item) => item,
Expand Down
Loading