Struct linfa_clustering::DbscanParams

source · [−]

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

Expand description

Helper struct for building a set of DBSCAN hyperparameters

Implementations

source

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

source

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

Set the tolerance

source

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

Set the nearest neighbour algorithm to be used

source

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

Set the distance metric

Trait Implementations

source

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

source

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

Formats the value using the given formatter. Read more

source

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

source

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

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

source

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

Checks the hyperparameters and returns the checked hyperparameters if successful

source

fn check_unwrap(self) -> Self::Checked

Calls check() and unwraps the result

source

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

Auto Trait Implementations

impl<F, D, N> RefUnwindSafe for DbscanParams<F, D, N> where
 D: RefUnwindSafe,
 F: RefUnwindSafe,
 N: RefUnwindSafe,

impl<F, D, N> Send for DbscanParams<F, D, N> where
N: Send,

impl<F, D, N> Sync for DbscanParams<F, D, N> where
N: Sync,

impl<F, D, N> Unpin for DbscanParams<F, D, N> where
 D: Unpin,
 F: Unpin,
 N: Unpin,

impl<F, D, N> UnwindSafe for DbscanParams<F, D, N> where
 D: UnwindSafe,
 F: UnwindSafe,
 N: UnwindSafe,

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

pub 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

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct linfa_clustering::DbscanParams

Implementations

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

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

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

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

Trait Implementations

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

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

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

type Checked = DbscanValidParams<F, D, N>

type Error = DbscanParamsError

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

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

fn check_unwrap(self) -> Self::Checked

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

Auto Trait Implementations

impl<F, D, N> RefUnwindSafe for DbscanParams<F, D, N> where D: RefUnwindSafe, F: RefUnwindSafe, N: RefUnwindSafe,

impl<F, D, N> Send for DbscanParams<F, D, N> where N: Send,

impl<F, D, N> Sync for DbscanParams<F, D, N> where N: Sync,

impl<F, D, N> Unpin for DbscanParams<F, D, N> where D: Unpin, F: Unpin, N: Unpin,

impl<F, D, N> UnwindSafe for DbscanParams<F, D, N> where D: UnwindSafe, F: UnwindSafe, N: UnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

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

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

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

pub unsafe fn drop(ptr: usize)

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

type Error = Infallible

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

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

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

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

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

pub fn vzip(self) -> V

impl<F, D, N> RefUnwindSafe for DbscanParams<F, D, N> where
D: RefUnwindSafe,
F: RefUnwindSafe,
N: RefUnwindSafe,

impl<F, D, N> Send for DbscanParams<F, D, N> where
N: Send,

impl<F, D, N> Sync for DbscanParams<F, D, N> where
N: Sync,

impl<F, D, N> Unpin for DbscanParams<F, D, N> where
D: Unpin,
F: Unpin,
N: Unpin,

impl<F, D, N> UnwindSafe for DbscanParams<F, D, N> where
D: UnwindSafe,
F: UnwindSafe,
N: UnwindSafe,

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

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

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

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

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

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

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