Skip to main content

SugiyamaOptions

Struct SugiyamaOptions 

Source
pub struct SugiyamaOptions<'a> {
    pub layers: Option<&'a [i64]>,
    pub hgap: f64,
    pub vgap: f64,
    pub maxiter: usize,
    pub weights: Option<&'a [f64]>,
}
Expand description

Parameters of the Sugiyama layered layout (Graph::layout_sugiyama).

The Default uses automatic layering, unit gaps, 100 crossing minimization iterations and unit weights.

Fields§

§layers: Option<&'a [i64]>

Non-negative layer index of every vertex. Empty layers are skipped when minimizing crossings, but keep their room on the y axis. None lets igraph compute a layering, after breaking cycles.

§hgap: f64

Preferred minimum horizontal gap between vertices of a layer (default 1).

§vgap: f64

Distance between consecutive layers (default 1).

§maxiter: usize

Maximum number of iterations of the crossing minimization (default 100).

§weights: Option<&'a [f64]>

Edge weights, used only to break cycles: igraph tends to reverse edges with smaller weights.

Implementations§

Source§

impl<'a> SugiyamaOptions<'a>

Source

pub fn with_layers(self, layers: &'a [i64]) -> Self

Sets the layer of each vertex.

Trait Implementations§

Source§

impl<'a> Clone for SugiyamaOptions<'a>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for SugiyamaOptions<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SugiyamaOptions<'_>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'a> PartialEq for SugiyamaOptions<'a>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl<'a> StructuralPartialEq for SugiyamaOptions<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for SugiyamaOptions<'a>

§

impl<'a> RefUnwindSafe for SugiyamaOptions<'a>

§

impl<'a> Send for SugiyamaOptions<'a>

§

impl<'a> Sync for SugiyamaOptions<'a>

§

impl<'a> Unpin for SugiyamaOptions<'a>

§

impl<'a> UnsafeUnpin for SugiyamaOptions<'a>

§

impl<'a> UnwindSafe for SugiyamaOptions<'a>

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.