Struct vox_geometry_rust::point_parallel_hash_grid_searcher3::PointParallelHashGridSearcher3

pub struct PointParallelHashGridSearcher3 { /* fields omitted */ }

Parallel version of hash grid-based 3-D point searcher.

This class implements parallel version of 3-D point searcher by using hash grid for its internal acceleration data structure. Each point is recorded to its corresponding bucket where the hashing function is 3-D grid mapping.

Implementations

impl PointParallelHashGridSearcher3

pub fn new_default() -> PointParallelHashGridSearcher3

pub fn new_vec(
    resolution: USize3,
    grid_spacing: f64
) -> PointParallelHashGridSearcher3

Constructs hash grid with given resolution and grid spacing.

This constructor takes hash grid resolution and its grid spacing as its input parameters. The grid spacing must be 3x or greater than search radius.

• parameter: resolution The resolution.
• parameter: grid_spacing The grid spacing.

pub fn new(
    resolution_x: usize,
    resolution_y: usize,
    resolution_z: usize,
    grid_spacing: f64
) -> PointParallelHashGridSearcher3

Constructs hash grid with given resolution and grid spacing.

This constructor takes hash grid resolution and its grid spacing as its input parameters. The grid spacing must be 3x or greater than search radius.

• parameter: resolution_x The resolution x.
• parameter: resolution_y The resolution y.
• parameter: resolution_z The resolution z.
• parameter: grid_spacing The grid spacing.

pub fn builder() -> Builder

Returns builder fox PointHashGridSearcher3.

pub fn clone(&self) -> PointParallelHashGridSearcher3Ptr

Creates a new instance of the object with same properties than original.

• return Copy of this object.

pub fn set(&mut self, other: &PointParallelHashGridSearcher3)

Copy from the other instance.

impl PointParallelHashGridSearcher3

pub fn keys(&self) -> &Vec<usize>

Returns the hash key list.

The hash key list maps sorted point index i to its hash key value. The sorting order is based on the key value itself.

\return The hash key list.

pub fn start_index_table(&self) -> &Vec<usize>

Returns the start index table.

The start index table maps the hash grid bucket index to starting index of the sorted point list. Assume the hash key list looks like:

\code [5|8|8|10|10|10] \endcode

Then start_index_table and end_index_table should be like:

\code […..|0|…|1|..|3|..] […..|1|…|3|..|6|..] ^5 ^8 ^10 \endcode

So that end_index_table(i) - start_index_table(i) is the number points in i-th table bucket.

\return The start index table.

pub fn end_index_table(&self) -> &Vec<usize>

Returns the end index table.

The end index table maps the hash grid bucket index to starting index of the sorted point list. Assume the hash key list looks like:

\code [5|8|8|10|10|10] \endcode

Then start_index_table and end_index_table should be like:

\code […..|0|…|1|..|3|..] […..|1|…|3|..|6|..] ^5 ^8 ^10 \endcode

So that end_index_table(i) - start_index_table(i) is the number points in i-th table bucket.

\return The end index table.

pub fn sorted_indices(&self) -> &Vec<usize>

Returns the sorted indices of the points.

When the hash grid is built, it sorts the points in hash key order. But rather than sorting the original points, this class keeps the shuffled indices of the points. The list this function returns maps sorted index i to original index j.

\return The sorted indices of the points.

pub fn get_hash_key_from_bucket_index(&self, bucket_index: &ISize3) -> usize

Returns the hash value for given 3-D bucket index.

• parameter: bucket_index The bucket index.

\return The hash key from bucket index.

pub fn get_bucket_index(&self, position: &Vector3D) -> ISize3

Gets the bucket index from a point.

• parameter: position The position of the point.

• return The bucket index.

pub fn get_hash_key_from_position(&self, position: &Vector3D) -> usize

pub fn get_nearby_keys(&self, position: &Vector3D, nearby_keys: &mut [usize; 8])

Trait Implementations

impl PointNeighborSearcher3 for PointParallelHashGridSearcher3

fn type_name() -> String

Returns the type name of the derived class.

fn build(&mut self, points: &Vec<Vector3D>)

Builds internal acceleration structure for given points list.

fn for_each_nearby_point<Callback>(
    &self,
    origin: &Vector3D,
    radius: f64,
    callback: &mut Callback
) where
    Callback: ForEachNearbyPointFunc, 

Invokes the callback function for each nearby point around the origin within given radius.

fn has_nearby_point(&self, origin: &Vector3D, radius: f64) -> bool

Returns true if there are any nearby points for given origin within radius.