Struct linfa_clustering::OpticsParams

source · [−]

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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

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. Read more

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 Read more

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: 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 ==. Read more

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

This method tests for !=.

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

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

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V