Struct linfa_clustering::AppxDbscanHyperParams

pub struct AppxDbscanHyperParams<F: Float> { /* fields omitted */ }

The set of hyperparameters that can be specified for the execution of the Approximated DBSCAN algorithm.

Implementations

impl<F: Float> AppxDbscanHyperParams<F>

pub fn new(min_points: usize) -> AppxDbscanHyperParamsBuilder<F>

Minimum number of neighboring points a point needs to have to be a core point and not a noise point.

Defaults are provided if the optional parameters are not specified:

• tolerance = 1e-4
• slack = 1e-2

pub fn tolerance(&self) -> F

Two points are considered neighbors if the euclidean distance between them is below the tolerance

pub fn minimum_points(&self) -> usize

Minimum number of a points in a neighborhood around a point for it to not be considered noise

pub fn slack(&self) -> F

Approximation factor, allows the distance between two points for them to be considered neighbours to reach tolerance * (1 + slack)

pub fn appx_tolerance(&self) -> F

Maximum approximated radius, equal to tolerance * (1 + slack)

Trait Implementations

impl<F: Clone + Float> Clone for AppxDbscanHyperParams<F>

fn clone(&self) -> AppxDbscanHyperParams<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug + Float> Debug for AppxDbscanHyperParams<F>

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

Formats the value using the given formatter.

impl<F: PartialEq + Float> PartialEq<AppxDbscanHyperParams<F>> for AppxDbscanHyperParams<F>

fn eq(&self, other: &AppxDbscanHyperParams<F>) -> bool

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

fn ne(&self, other: &AppxDbscanHyperParams<F>) -> bool

This method tests for !=.

impl<F: Float> StructuralPartialEq for AppxDbscanHyperParams<F>

impl<F: Float, D: Data<Elem = F>> Transformer<&'_ ArrayBase<D, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<Option<usize>>, Dim<[usize; 1]>>> for AppxDbscanHyperParams<F>

fn transform(&self, observations: &ArrayBase<D, Ix2>) -> Array1<Option<usize>>

impl<F: Float, D: Data<Elem = F>, T> Transformer<DatasetBase<ArrayBase<D, Dim<[usize; 2]>>, T>, DatasetBase<ArrayBase<D, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<Option<usize>>, Dim<[usize; 1]>>>> for AppxDbscanHyperParams<F>

fn transform(
    &self,
    dataset: DatasetBase<ArrayBase<D, Ix2>, T>
) -> DatasetBase<ArrayBase<D, Ix2>, Array1<Option<usize>>>