Struct linfa_clustering::DbscanParams

pub struct DbscanParams<F: Float, D: Distance<F>, N: NearestNeighbour>(_);

Helper struct for building a set of DBSCAN hyperparameters

Implementations

impl<F: Float, D: Distance<F>, N: NearestNeighbour> DbscanParams<F, D, N>

pub fn tolerance(self, tolerance: F) -> Self

Set the tolerance

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

Set the nearest neighbour algorithm to be used

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

Set the distance metric

Trait Implementations

impl<F: Clone + Float, D: Clone + Distance<F>, N: Clone + NearestNeighbour> Clone for DbscanParams<F, D, N>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug + Float, D: Debug + Distance<F>, N: Debug + NearestNeighbour> Debug for DbscanParams<F, D, N>

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

Formats the value using the given formatter.

impl<F: Float, D: Distance<F>, N: NearestNeighbour> ParamGuard for DbscanParams<F, D, N>

type Checked = DbscanValidParams<F, D, N>

The checked hyperparameters

type Error = DbscanParamsError

Error type resulting from failed hyperparameter checking

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

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

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

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 + Float, D: PartialEq + Distance<F>, N: PartialEq + NearestNeighbour> PartialEq<DbscanParams<F, D, N>> for DbscanParams<F, D, N>

fn eq(&self, other: &DbscanParams<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: Float, D: Distance<F>, N: NearestNeighbour> StructuralPartialEq for DbscanParams<F, D, N>

impl<F: Float, D: Distance<F>, N: NearestNeighbour> TransformGuard for DbscanParams<F, D, N>