Struct KamadaKawaiOptions 

pub struct KamadaKawaiOptions<'a> {
    pub maxiter: Option<usize>,
    pub epsilon: f64,
    pub kkconst: Option<f64>,
    pub weights: Option<&'a [f64]>,
    pub initial: Option<&'a Matrix>,
    pub minx: Option<&'a [f64]>,
    pub maxx: Option<&'a [f64]>,
    pub miny: Option<&'a [f64]>,
    pub maxy: Option<&'a [f64]>,
    pub minz: Option<&'a [f64]>,
    pub maxz: Option<&'a [f64]>,
}

Parameters of the Kamada–Kawai layouts (Graph::layout_kamada_kawai and Graph::layout_kamada_kawai_3d).

The Default uses 50 n iterations (the C documentation asks for at least 10 n; 50 n is the default of the R and Python interfaces), epsilon = 0 (always run all the iterations), kkconst = n (as the C documentation recommends), unit edge lengths, a circular (spherical in 3D) start and no bounds.

Fields

maxiter: Option<usize>

Maximum number of iterations; None means 50 n.

epsilon: f64

Stop when the maximum energy change falls below this value (0.0, the default, performs all maxiter iterations).

kkconst: Option<f64>

The vertex attraction constant; None means the number of vertices.

weights: Option<&'a [f64]>

Positive edge lengths used in the shortest path computation (higher weight: farther vertices). None means unit lengths.

initial: Option<&'a Matrix>

Starting positions (n × 2, or n × 3 for the 3D version). None starts from a circle (sphere) of radius 0.36 sqrt(n), or from a random layout when some bounds are given.

minx: Option<&'a [f64]>

Per-vertex minimum x coordinate (-inf means no bound).

maxx: Option<&'a [f64]>

Per-vertex maximum x coordinate (+inf means no bound).

miny: Option<&'a [f64]>

Per-vertex minimum y coordinate (-inf means no bound).

maxy: Option<&'a [f64]>

Per-vertex maximum y coordinate (+inf means no bound).

minz: Option<&'a [f64]>

Per-vertex minimum z coordinate (3D only).

maxz: Option<&'a [f64]>

Per-vertex maximum z coordinate (3D only).

Implementations

impl<'a> KamadaKawaiOptions<'a>

pub fn with_weights(self, weights: &'a [f64]) -> Self

Sets the edge lengths.

pub fn with_initial(self, initial: &'a Matrix) -> Self

Sets the starting positions.

Trait Implementations

impl<'a> Clone for KamadaKawaiOptions<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for KamadaKawaiOptions<'a>

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

Formats the value using the given formatter.

impl<'a> Default for KamadaKawaiOptions<'a>

fn default() -> KamadaKawaiOptions<'a>

Returns the “default value” for a type.

impl<'a> PartialEq for KamadaKawaiOptions<'a>

fn eq(&self, other: &KamadaKawaiOptions<'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 KamadaKawaiOptions<'a>