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: 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::Checked

Calls check() and unwraps the result

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