Skip to main content

SliceHeap

Struct SliceHeap 

Source
pub struct SliceHeap<'a, T: Ord + Copy> { /* private fields */ }
Expand description

A fixed-size heap data structure that operates in place on non-empty mutable slices.

The heap size never changes after creation, and only supports updating the maximum element.

Implementations§

Source§

impl<'a, T: Ord + Copy> SliceHeap<'a, T>

Source

pub fn new(data: &'a mut [T]) -> Result<Self, EmptySlice>

Creates a new SliceHeap from a mutable slice. The slice is assumed to be unordered initially and will be heapified.

§Errors

Returns EmptySlice if the input slice is empty.

Source

pub fn new_unchecked(data: &'a mut [T]) -> Result<Self, EmptySlice>

Creates a new SliceHeap from a mutable slice without heapifying. Use this if you know the slice is already in heap order.

§Errors

Returns EmptySlice if the input slice is empty.

Source

pub fn len(&self) -> usize

Returns the number of elements in the heap.

Source

pub fn is_empty(&self) -> bool

Always returns false as the heap can never be empty

Source

pub fn peek(&self) -> Option<&T>

Returns a reference to the greatest element in the heap, or None if empty.

Source

pub fn update_root<F>(&mut self, update_fn: F)
where F: FnOnce(&mut T),

Updates the root element in place and restores the heap property. This allows direct mutation of the maximum element.

Since the heap cannot be empty (enforced by construction), this operation always succeeds.

Source

pub fn heapify(&mut self)

Converts the entire slice into a heap.

Source

pub fn as_slice(&self) -> &[T]

Returns a slice of all heap elements in heap order (not sorted order).

Auto Trait Implementations§

§

impl<'a, T> Freeze for SliceHeap<'a, T>

§

impl<'a, T> RefUnwindSafe for SliceHeap<'a, T>
where T: RefUnwindSafe,

§

impl<'a, T> Send for SliceHeap<'a, T>
where T: Send,

§

impl<'a, T> Sync for SliceHeap<'a, T>
where T: Sync,

§

impl<'a, T> Unpin for SliceHeap<'a, T>

§

impl<'a, T> !UnwindSafe for SliceHeap<'a, T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> AsyncFriendly for T
where T: Send + Sync + 'static,