Skip to main content

RTreePartitioner

Struct RTreePartitioner 

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

RTree-based spatial partitioner that uses pre-defined partition boundaries.

This partitioner constructs an RTree index over a set of partition boundaries (rectangles) and uses it to efficiently determine which partition a given bounding box belongs to based on spatial intersection.

Implementations§

Source§

impl RTreePartitioner

Source

pub fn try_new(boundaries: Vec<BoundingBox>) -> Result<Self>

Create a new RTree partitioner from a collection of partition boundaries.

§Arguments
  • boundaries - A vector of bounding boxes representing partition boundaries. Each bounding box defines the spatial extent of one partition. The partition ID is the index in this vector.
§Errors

Returns an error if any boundary has wraparound coordinates (not supported)

§Example
use sedona_geometry::bounding_box::BoundingBox;
use sedona_spatial_join::partitioning::rtree::RTreePartitioner;

let boundaries = vec![
    BoundingBox::xy((0.0, 50.0), (0.0, 50.0)),
    BoundingBox::xy((50.0, 100.0), (0.0, 50.0)),
];
let partitioner = RTreePartitioner::try_new(boundaries).unwrap();
Source

pub fn try_new_with_node_size( boundaries: Vec<BoundingBox>, node_size: u16, ) -> Result<Self>

Create a new RTree partitioner with a custom node size.

Source

pub fn depth(&self) -> usize

Return the number of levels in the underlying RTree.

Trait Implementations§

Source§

impl Clone for RTreePartitioner

Source§

fn clone(&self) -> RTreePartitioner

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl SpatialPartitioner for RTreePartitioner

Source§

fn num_regular_partitions(&self) -> usize

Get the total number of spatial partitions, excluding the None partition and Multi partition.
Source§

fn partition(&self, bbox: &BoundingBox) -> Result<SpatialPartition>

Given a bounding box, return the partition it is assigned to.
Source§

fn partition_no_multi(&self, bbox: &BoundingBox) -> Result<SpatialPartition>

Given a bounding box, return the partition it is assigned to. This function never returns Multi partition. If bbox intersects with multiple partitions, only one of them will be selected as regular partition.
Source§

fn box_clone(&self) -> Box<dyn SpatialPartitioner>

Clone the partitioner as a boxed trait object.

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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<G1, G2> Within<G2> for G1
where G2: Contains<G1>,

Source§

fn is_within(&self, b: &G2) -> bool

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,