Trait IndexTrait

pub trait IndexTrait: IndexTraitConst {
    // Required method
    fn as_raw_mut_Index(&mut self) -> *mut c_void;

    // Provided methods
    fn build(
        &mut self,
        features: &impl ToInputArray,
        params: &impl IndexParamsTraitConst,
        dist_type: flann_distance_t,
    ) -> Result<()> { ... }
    fn build_def(
        &mut self,
        features: &impl ToInputArray,
        params: &impl IndexParamsTraitConst,
    ) -> Result<()> { ... }
    fn knn_search(
        &mut self,
        query: &impl ToInputArray,
        indices: &mut impl ToOutputArray,
        dists: &mut impl ToOutputArray,
        knn: i32,
        params: &impl SearchParamsTraitConst,
    ) -> Result<()> { ... }
    fn knn_search_def(
        &mut self,
        query: &impl ToInputArray,
        indices: &mut impl ToOutputArray,
        dists: &mut impl ToOutputArray,
        knn: i32,
    ) -> Result<()> { ... }
    fn radius_search(
        &mut self,
        query: &impl ToInputArray,
        indices: &mut impl ToOutputArray,
        dists: &mut impl ToOutputArray,
        radius: f64,
        max_results: i32,
        params: &impl SearchParamsTraitConst,
    ) -> Result<i32> { ... }
    fn radius_search_def(
        &mut self,
        query: &impl ToInputArray,
        indices: &mut impl ToOutputArray,
        dists: &mut impl ToOutputArray,
        radius: f64,
        max_results: i32,
    ) -> Result<i32> { ... }
    fn load(
        &mut self,
        features: &impl ToInputArray,
        filename: &str,
    ) -> Result<bool> { ... }
    fn release(&mut self) -> Result<()> { ... }
}

Mutable methods for crate::flann::Index

Required Methods

fn as_raw_mut_Index(&mut self) -> *mut c_void

Provided Methods

fn build( &mut self, features: &impl ToInputArray, params: &impl IndexParamsTraitConst, dist_type: flann_distance_t, ) -> Result<()>

C++ default parameters

• dist_type: cvflann::FLANN_DIST_L2

fn build_def( &mut self, features: &impl ToInputArray, params: &impl IndexParamsTraitConst, ) -> Result<()>

Note

This alternative version of IndexTrait::build function uses the following default values for its arguments:

• dist_type: cvflann::FLANN_DIST_L2

fn knn_search( &mut self, query: &impl ToInputArray, indices: &mut impl ToOutputArray, dists: &mut impl ToOutputArray, knn: i32, params: &impl SearchParamsTraitConst, ) -> Result<()>

C++ default parameters

• params: SearchParams()

fn knn_search_def( &mut self, query: &impl ToInputArray, indices: &mut impl ToOutputArray, dists: &mut impl ToOutputArray, knn: i32, ) -> Result<()>

Note

This alternative version of IndexTrait::knn_search function uses the following default values for its arguments:

• params: SearchParams()

fn radius_search( &mut self, query: &impl ToInputArray, indices: &mut impl ToOutputArray, dists: &mut impl ToOutputArray, radius: f64, max_results: i32, params: &impl SearchParamsTraitConst, ) -> Result<i32>

C++ default parameters

• params: SearchParams()

fn radius_search_def( &mut self, query: &impl ToInputArray, indices: &mut impl ToOutputArray, dists: &mut impl ToOutputArray, radius: f64, max_results: i32, ) -> Result<i32>

Note

This alternative version of IndexTrait::radius_search function uses the following default values for its arguments:

• params: SearchParams()

fn load(&mut self, features: &impl ToInputArray, filename: &str) -> Result<bool>

fn release(&mut self) -> Result<()>

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl IndexTrait for BoxedRefMut<'_, Index>

impl IndexTrait for Index