Struct linfa_clustering::OpticsParams

pub struct OpticsParams<F, D, N>(_);

Implementations

impl<F: Float, D, N> OpticsParams<F, D, N>

pub fn new(min_points: usize, dist_fn: D, nn_algo: N) -> 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.

pub fn dist_fn(self, dist_fn: D) -> Self

Distance metric to be used for the algorithm

pub fn nn_algo(self, nn_algo: N) -> Self

Nearest Neighbour algorithm to use to find the nearest points

Trait Implementations

impl<F: Clone, D: Clone, N: Clone> Clone for OpticsParams<F, D, N>

fn clone(&self) -> OpticsParams<F, D, N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug, D: Debug, N: Debug> Debug for OpticsParams<F, D, N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<F: Float, D, N> ParamGuard for OpticsParams<F, D, N>

type Checked = OpticsValidParams<F, D, N>

The checked hyperparameters

type Error = OpticsError

Error type resulting from failed hyperparameter checking

fn check_ref(&self) -> Result<&Self::Checked, OpticsError>

Checks the hyperparameters and returns a reference to the checked hyperparameters if successful

fn check(self) -> Result<Self::Checked, OpticsError>

Checks the hyperparameters and returns the checked hyperparameters if successful

fn check_unwrap(self) -> Self::Checkedwhere
    Self: Sized,

Calls check() and unwraps the result

impl<F: PartialEq, D: PartialEq, N: PartialEq> PartialEq<OpticsParams<F, D, N>> for OpticsParams<F, D, N>

fn eq(&self, other: &OpticsParams<F, D, N>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<F, D, N> StructuralPartialEq for OpticsParams<F, D, N>

impl<F: Float, D, N> TransformGuard for OpticsParams<F, D, N>