SumTree

Struct SumTree 

Source
pub struct SumTree { /* private fields */ }
Expand description

Binary sum-tree for O(log N) prefix-sum queries.

Internally stores 2 * capacity nodes where leaves occupy indices [capacity .. 2*capacity) and internal nodes hold partial sums.

Implementations§

Source§

impl SumTree

Source

pub fn new(capacity: usize) -> Self

Create a sum-tree with capacity leaves, all initialised to zero.

The capacity is rounded up to the next power of two for efficient binary-tree indexing. Unused leaves beyond the logical capacity hold priority 0.0 (sum-tree) and f64::INFINITY (min-tree). The min() method may therefore return INFINITY when the buffer is not full; callers should handle this (see PrioritizedReplayBuffer::tree_min_prob).

Source

pub fn capacity(&self) -> usize

Number of leaves.

Source

pub fn total(&self) -> f64

Sum of all leaf priorities.

Source

pub fn min(&self) -> f64

Minimum leaf priority (O(1) via the min-tree).

Source

pub fn set(&mut self, index: usize, priority: f64)

Set the priority of leaf index.

§Panics (debug only)

Panics in debug builds if index >= capacity.

Source

pub fn get(&self, index: usize) -> f64

Get the priority of leaf index.

§Panics (debug only)

Panics in debug builds if index >= capacity.

Source

pub fn sample(&self, value: f64) -> usize

Sample a leaf index such that the probability of choosing leaf i is priority[i] / total().

value should be in [0, total()).

Trait Implementations§

Source§

impl Debug for SumTree

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> 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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

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.
§

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

§

fn vzip(self) -> V