mirror of
https://gitlab.freedesktop.org/mesa/mesa.git
synced 2026-02-02 04:30:25 +01:00
Rename it to SmallVec, make it more generic and switch NAK to it. Signed-off-by: Christian Gmeiner <cgmeiner@igalia.com> Reviewed-by: Faith Ekstrand <faith.ekstrand@collabora.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/31409>
83 lines
2.7 KiB
Rust
83 lines
2.7 KiB
Rust
// Copyright © 2022 Collabora, Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
/// `SmallVec` is an optimized data structure that handles collections of items.
|
|
/// It is designed to avoid allocating a `Vec` unless multiple items are present.
|
|
///
|
|
/// # Variants
|
|
///
|
|
/// * `None` - Represents an empty collection, no items are stored.
|
|
/// * `One(T)` - Stores a single item without allocating a `Vec`.
|
|
/// * `Many(Vec<T>)` - Stores multiple items in a heap-allocated `Vec`.
|
|
///
|
|
/// This helps to reduce the amount of Vec's allocated in the optimization passes.
|
|
pub enum SmallVec<T> {
|
|
None,
|
|
One(T),
|
|
Many(Vec<T>),
|
|
}
|
|
|
|
impl<T> SmallVec<T> {
|
|
/// Adds an item to the `SmallVec`.
|
|
///
|
|
/// If the collection is empty (`None`), the item is stored as `One`.
|
|
/// If the collection has one item (`One`), it transitions to `Many` and both items are stored in a `Vec`.
|
|
/// If the collection is already in the `Many` variant, the new item is pushed into the existing `Vec`.
|
|
///
|
|
/// # Arguments
|
|
///
|
|
/// * `item` - The item to be added.
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```
|
|
/// let mut vec: SmallVec<String> = SmallVec::None;
|
|
/// vec.push("Hello".to_string());
|
|
/// vec.push("World".to_string());
|
|
/// ```
|
|
pub fn push(&mut self, i: T) {
|
|
match self {
|
|
SmallVec::None => {
|
|
*self = SmallVec::One(i);
|
|
}
|
|
SmallVec::One(_) => {
|
|
*self = match std::mem::replace(self, SmallVec::None) {
|
|
SmallVec::One(o) => SmallVec::Many(vec![o, i]),
|
|
_ => panic!("Not a One"),
|
|
};
|
|
}
|
|
SmallVec::Many(v) => {
|
|
v.push(i);
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Returns a mutable reference to the last item in the `SmallVec`, if it exists.
|
|
///
|
|
/// * If the collection is empty (`None`), it returns `None`.
|
|
/// * If the collection has one item (`One`), it returns a mutable reference to that item.
|
|
/// * If the collection has multiple items (`Many`), it returns a mutable reference to the last item in the `Vec`.
|
|
///
|
|
/// # Returns
|
|
///
|
|
/// * `Option<&mut T>` - A mutable reference to the last item, or `None` if the collection is empty.
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```
|
|
/// let mut vec: SmallVec<i32> = SmallVec::None;
|
|
/// vec.push(1);
|
|
/// vec.push(2);
|
|
///
|
|
/// if let Some(last) = vec.last_mut() {
|
|
/// *last = 10; // Modify the last element.
|
|
/// }
|
|
/// ```
|
|
pub fn last_mut(&mut self) -> Option<&mut T> {
|
|
match self {
|
|
SmallVec::None => None,
|
|
SmallVec::One(item) => Some(item),
|
|
SmallVec::Many(v) => v.last_mut(),
|
|
}
|
|
}
|
|
}
|