Struct UmapOptions 

pub struct UmapOptions<'a> {
    pub distances: Option<&'a [f64]>,
    pub min_dist: f64,
    pub epochs: usize,
    pub distances_are_weights: bool,
    pub initial: Option<&'a Matrix>,
}

Parameters of the UMAP layouts (Graph::layout_umap and Graph::layout_umap_3d).

The Default uses min_dist = 0.01, 500 epochs, unit distances and a random start.

Fields

distances: Option<&'a [f64]>

Distance (or, with distances_are_weights, weight) of every edge; None means all edges have the same distance.

min_dist: f64

How close two unconnected vertices may get before repelling each other; non-negative, typically in [0, 1] (default 0.01).

epochs: usize

Number of epochs of stochastic gradient descent, typically in [30, 500] (default 500).

distances_are_weights: bool

Whether distances already holds UMAP weights (e.g. from Graph::layout_umap_compute_weights).

initial: Option<&'a Matrix>

Starting positions (n × 2, or n × 3 for the 3D version); None starts from a random layout.

Trait Implementations

impl<'a> Clone for UmapOptions<'a>

fn clone(&self) -> UmapOptions<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for UmapOptions<'a>

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

Formats the value using the given formatter.

impl Default for UmapOptions<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> PartialEq for UmapOptions<'a>

fn eq(&self, other: &UmapOptions<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> StructuralPartialEq for UmapOptions<'a>