Struct linfa_clustering::AppxDbscanValidParams

source · [−]

pub struct AppxDbscanValidParams<F: Float, N> { /* private fields */ }

Expand description

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

Implementations

source

impl<F: Float, N> AppxDbscanValidParams<F, N>

source

pub fn tolerance(&self) -> F

Distance between points for them to be considered neighbours.

source

pub fn minimum_points(&self) -> usize

Distance between points for them to be considered neighbours.

source

pub fn slack(&self) -> F

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

source

pub fn appx_tolerance(&self) -> F

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

source

pub fn nn_algo(&self) -> &N

Nearest neighbour algorithm used for range queries

Trait Implementations

source

impl<F: Clone + Float, N: Clone> Clone for AppxDbscanValidParams<F, N>

source

fn clone(&self) -> AppxDbscanValidParams<F, 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

source

impl<F: Debug + Float, N: Debug> Debug for AppxDbscanValidParams<F, N>

source

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

Formats the value using the given formatter. Read more

source

impl<F: PartialEq + Float, N: PartialEq> PartialEq<AppxDbscanValidParams<F, N>> for AppxDbscanValidParams<F, N>

source

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

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

source

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

This method tests for !=.

source

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

source

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

source

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

source

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

source

impl<F: Float, N> StructuralPartialEq for AppxDbscanValidParams<F, N>

Auto Trait Implementations

impl<F, N> RefUnwindSafe for AppxDbscanValidParams<F, N> where
F: RefUnwindSafe,
N: RefUnwindSafe,

impl<F, N> Send for AppxDbscanValidParams<F, N> where
N: Send,

impl<F, N> Sync for AppxDbscanValidParams<F, N> where
N: Sync,

impl<F, N> Unpin for AppxDbscanValidParams<F, N> where
N: Unpin,

impl<F, N> UnwindSafe for AppxDbscanValidParams<F, N> where
F: UnwindSafe,
N: UnwindSafe,

Blanket Implementations

source

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

source

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

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

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

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into 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

source

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

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

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

source

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

Uses borrowed data to replace owned data, usually by cloning. 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

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

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

Performs the conversion.

Struct linfa_clustering::AppxDbscanValidParams

Implementations

impl<F: Float, N> AppxDbscanValidParams<F, N>

pub fn tolerance(&self) -> F

pub fn minimum_points(&self) -> usize

pub fn slack(&self) -> F

pub fn appx_tolerance(&self) -> F

pub fn nn_algo(&self) -> &N

Trait Implementations

impl<F: Clone + Float, N: Clone> Clone for AppxDbscanValidParams<F, N>

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

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

impl<F: Debug + Float, N: Debug> Debug for AppxDbscanValidParams<F, N>

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

impl<F: PartialEq + Float, N: PartialEq> PartialEq<AppxDbscanValidParams<F, N>> for AppxDbscanValidParams<F, N>

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

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

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

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

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

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

impl<F: Float, N> StructuralPartialEq for AppxDbscanValidParams<F, N>

Auto Trait Implementations

impl<F, N> RefUnwindSafe for AppxDbscanValidParams<F, N> where F: RefUnwindSafe, N: RefUnwindSafe,

impl<F, N> Send for AppxDbscanValidParams<F, N> where N: Send,

impl<F, N> Sync for AppxDbscanValidParams<F, N> where N: Sync,

impl<F, N> Unpin for AppxDbscanValidParams<F, N> where N: Unpin,

impl<F, N> UnwindSafe for AppxDbscanValidParams<F, N> where F: UnwindSafe, N: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Pointable for T

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

type Init = T

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

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

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

unsafe fn drop(ptr: usize)

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

fn vzip(self) -> V

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

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

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

impl<F, N> RefUnwindSafe for AppxDbscanValidParams<F, N> where
F: RefUnwindSafe,
N: RefUnwindSafe,

impl<F, N> Send for AppxDbscanValidParams<F, N> where
N: Send,

impl<F, N> Sync for AppxDbscanValidParams<F, N> where
N: Sync,

impl<F, N> Unpin for AppxDbscanValidParams<F, N> where
N: Unpin,

impl<F, N> UnwindSafe for AppxDbscanValidParams<F, N> where
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> ToOwned for T where
T: Clone,

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>,