Struct box_intersect_ze::set::BBoxSet

pub struct BBoxSet<B: BBox, ID> {
    pub boxes: Vec<(B, ID)>,
}

A generic set of BBoxes of type B with identifiers of type ID

Fields

boxes: Vec<(B, ID)>

Implementations

impl<B, ID> BBoxSet<B, ID> where
    B: BBox,
    ID: Copy + PartialEq,
    B::Num: PartialOrd, 

pub fn new() -> Self

Creates a new, empty set. Prefer BBoxSet::with_capacity.

pub fn with_capacity(capacity: usize) -> Self

Creates a new, empty set with the specified capacity. See Vec::with_capacity.

pub fn push(&mut self, id: ID, bbox: B)

Adds a box with an identifier to the set.

• id must be a unique identifier for that box. If you want to use algorithms other than brute force to find intersections, ID must be PartialOrd

pub fn clear(&mut self)

Removes all boxes from the set.

pub fn sort(&mut self)

Sorts the boxes in the set by their low boundaries in dimension 0. Needed for the intersection finding algorithms.

pub fn len(&self) -> usize

Returns the number of boxes in the set.

pub fn get(&self, idx: usize) -> (B, ID)

Returns the box at the given index and its identifier.

pub fn find(&self, id: ID) -> Option<B>

Performs a linear search for the box with the given identifier. Returns Some if found, None otherwise.

pub fn empty(&self) -> bool

Returns true if the set is empty.

pub fn filter<P>(&self, pred: P) -> Self where
    P: FnMut(&&(B, ID)) -> bool, 

Returns a subset of the set, containing only those boxes that match the given predicate. If the set is sorted, the sorting is preserved in the subset.

pub fn partition<P>(&self, pred: P) -> (Self, Self) where
    P: FnMut(&&(B, ID)) -> bool, 

Returns a pair of subsets of the set, containing:

• those boxes for which the given predicate returns true
• those for which it returns false

If the set is sorted, the sorting is preserved in the subsets.

pub fn approx_median<R: Rng>(&self, dim: usize, rand: &mut R) -> B::Num

Returns an approximate median of the low boundaries in dimension dim of the boxes, obtained by recursively calculating medians of three (medians of …) random elements

• rand must be a random number generator implementing the Rng trait.

Trait Implementations

impl<B: Clone + BBox, ID: Clone> Clone for BBoxSet<B, ID>

fn clone(&self) -> BBoxSet<B, ID>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B, ID> Debug for BBoxSet<B, ID> where
    B: BBox + Debug,
    ID: Debug, 

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

Formats the value using the given formatter.