Skip to main content

KkParams3d

Struct KkParams3d 

Source
pub struct KkParams3d {
    pub maxiter: usize,
    pub epsilon: f64,
    pub kkconst: f64,
    pub seed: Option<Vec<[f64; 3]>>,
}
Expand description

Parameters for the 3D Kamada-Kawai layout.

Fields§

§maxiter: usize

Maximum number of iterations. Default: 10 * vcount.

§epsilon: f64

Stop when the maximum energy-gradient magnitude squared falls below this threshold.

§kkconst: f64

Spring constant K. Default: vcount as f64.

§seed: Option<Vec<[f64; 3]>>

Optional initial positions (row per vertex: [x, y, z]). If None, a scaled sphere layout is used.

Implementations§

Source§

impl KkParams3d

Source

pub fn default_for(n: usize) -> Self

Reasonable defaults for a graph with n vertices.

§Examples
use rust_igraph::KkParams3d;

let params = KkParams3d::default_for(50);
assert_eq!(params.maxiter, 500);

Trait Implementations§

Source§

impl Clone for KkParams3d

Source§

fn clone(&self) -> KkParams3d

Returns a duplicate 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 Debug for KkParams3d

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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.

Source§

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

Source§

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<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.