Struct linfa_clustering::OpticsParams
source · [−]pub struct OpticsParams<F, D, N>(_);
Implementations
sourceimpl<F: Float, D, N> OpticsParams<F, D, N>
impl<F: Float, D, N> OpticsParams<F, D, N>
pub fn new(min_points: usize, dist_fn: D, nn_algo: N) -> Self
sourcepub fn tolerance(self, tolerance: F) -> Self
pub fn tolerance(self, tolerance: F) -> Self
Distance between points for them to be considered neighbors. Compared to DBSCAN this parameter isn’t strictly necessary but improves execution time by not considering every point. If the tolerance is too low the distances calculated are undefined and no clusters will be returned.
Trait Implementations
sourceimpl<F: Float, D, N> ParamGuard for OpticsParams<F, D, N>
impl<F: Float, D, N> ParamGuard for OpticsParams<F, D, N>
type Checked = OpticsValidParams<F, D, N>
type Checked = OpticsValidParams<F, D, N>
The checked hyperparameters
type Error = OpticsError
type Error = OpticsError
Error type resulting from failed hyperparameter checking
sourcefn check_ref(&self) -> Result<&Self::Checked, OpticsError>
fn check_ref(&self) -> Result<&Self::Checked, OpticsError>
Checks the hyperparameters and returns a reference to the checked hyperparameters if successful Read more
sourcefn check(self) -> Result<Self::Checked, OpticsError>
fn check(self) -> Result<Self::Checked, OpticsError>
Checks the hyperparameters and returns the checked hyperparameters if successful
sourcefn check_unwrap(self) -> Self::Checked
fn check_unwrap(self) -> Self::Checked
Calls check()
and unwraps the result
impl<F: Float, D, N> TransformGuard for OpticsParams<F, D, N>
Auto Trait Implementations
impl<F, D, N> RefUnwindSafe for OpticsParams<F, D, N> where
D: RefUnwindSafe,
F: RefUnwindSafe,
N: RefUnwindSafe,
impl<F, D, N> Send for OpticsParams<F, D, N> where
D: Send,
F: Send,
N: Send,
impl<F, D, N> Sync for OpticsParams<F, D, N> where
D: Sync,
F: Sync,
N: Sync,
impl<F, D, N> Unpin for OpticsParams<F, D, N> where
D: Unpin,
F: Unpin,
N: Unpin,
impl<F, D, N> UnwindSafe for OpticsParams<F, D, N> where
D: UnwindSafe,
F: UnwindSafe,
N: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more