Struct linfa_reduction::DiffusionMapParams

pub struct DiffusionMapParams(_);

Diffusion map hyperparameters

The diffusion map algorithms has only two explicit hyperparameter. The first is the stepsize. As the algorithm calculates the closeness of points after a number of steps taken in the diffusion graph, a larger step size introduces a more global behaviour of the projection while a smaller one (especially one) just projects close obserations closely together. The second parameter is the embedding size and defines the target dimensionality.

Implementations

impl DiffusionMapParams

pub fn steps(self, steps: usize) -> Self

Set the number of steps in the diffusion operator

The diffusion map algorithm expresses the transition probability with a kernel matrix and then takes multiple steps along the diffusion operator. In practice scales the eigenvalues of the decomposition exponentially with the number of steps.

pub fn embedding_size(self, embedding_size: usize) -> Self

pub fn new(embedding_size: usize) -> DiffusionMapParams

Creates the set of default parameters

Parameters

• embedding_size: the number of dimensions in the projection

Returns

Parameter set with number of steps = 1

Trait Implementations

impl Clone for DiffusionMapParams

fn clone(&self) -> DiffusionMapParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DiffusionMapParams

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

Formats the value using the given formatter.

impl Default for DiffusionMapParams

fn default() -> Self

Returns the “default value” for a type.

impl ParamGuard for DiffusionMapParams

type Checked = DiffusionMapValidParams

The checked hyperparameters

type Error = ReductionError

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 PartialEq<DiffusionMapParams> for DiffusionMapParams

fn eq(&self, other: &DiffusionMapParams) -> 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 Eq for DiffusionMapParams

impl StructuralEq for DiffusionMapParams

impl StructuralPartialEq for DiffusionMapParams

impl TransformGuard for DiffusionMapParams