Struct Index3DBuilder 

pub struct Index3DBuilder { /* private fields */ }

Builder for Index3D and, with the simd feature, SimdIndex3D.

Example

use packed_spatial_index::{Box3D, Index3DBuilder};

let mut builder = Index3DBuilder::new(2);
builder.add(Box3D::new(0.0, 0.0, 0.0, 1.0, 1.0, 1.0));
builder.add(Box3D::new(5.0, 5.0, 5.0, 6.0, 6.0, 6.0));

let index = builder.finish().unwrap();
assert_eq!(
    index.search(Box3D::new(0.0, 0.0, 0.0, 2.0, 2.0, 2.0)),
    vec![0]
);

Implementations

impl Index3DBuilder

pub fn new(count: usize) -> Self

Create a builder for exactly count items with DEFAULT_NODE_SIZE.

pub fn node_size(self, node_size: usize) -> Self

Set the maximum number of children per tree node (clamped to [2, 65535]).

pub fn sort_key(self, key: SortKey3D) -> Self

Choose the 3D sort key (default: SortKey3D::Hilbert).

pub fn parallel(self, parallel: bool) -> Self

Allow adaptive parallel builds through rayon.

Default is false. When set to true, rayon is used only when the item count is at least the current parallel_min_items threshold.

pub fn parallel_min_items(self, min_items: usize) -> Self

Set the minimum count at which parallel(true) actually enables rayon.

pub fn add(&mut self, item: Box3D)

Add one indexed box.

pub fn finish(self) -> Result<Index3D, BuildError>

Pack the tree and return the finished 3D index.

pub fn finish_simd(self) -> Result<SimdIndex3D, BuildError>

Pack the tree into the SIMD-accelerated SoA 3D index.

Example

use packed_spatial_index::{Index3DBuilder, Box3D};

let mut builder = Index3DBuilder::new(1);
builder.add(Box3D::new(0.0, 0.0, 0.0, 1.0, 1.0, 1.0));

let index = builder.finish_simd().unwrap();
assert_eq!(index.search(Box3D::new(0.5, 0.5, 0.5, 0.5, 0.5, 0.5)), vec![0]);