Skip to main content

HrgTree

Struct HrgTree 

Source
pub struct HrgTree {
    pub left: Vec<i32>,
    pub right: Vec<i32>,
    pub prob: Vec<f64>,
    pub vertices: Vec<i32>,
    pub edges: Vec<i32>,
    /* private fields */
}
Expand description

A hierarchical random graph represented as a binary dendrogram.

Internal vertices are identified by negative indices starting at -1 (the root). Leaf vertices use non-negative indices 0..n. Each internal vertex -(i+1) has its data at index i in the vectors.

§Example

use rust_igraph::HrgTree;

let hrg = HrgTree::new(3);
assert_eq!(hrg.size(), 3);
assert_eq!(hrg.num_internal(), 2);

Fields§

§left: Vec<i32>

Left child of each internal vertex. Negative = internal, non-negative = leaf.

§right: Vec<i32>

Right child of each internal vertex.

§prob: Vec<f64>

Connection probability at each internal vertex.

§vertices: Vec<i32>

Number of leaf vertices in the subtree of each internal vertex.

§edges: Vec<i32>

Number of tree edges in the subtree below each internal vertex.

Implementations§

Source§

impl HrgTree

Source

pub fn new(n: u32) -> Self

Create a new HRG with n leaf vertices, all arrays zero-initialized.

Source

pub fn size(&self) -> u32

The number of leaf vertices.

Source

pub fn num_internal(&self) -> usize

The number of internal vertices (size - 1, or 0 for trivial trees).

Source

pub fn resize(&mut self, new_size: u32)

Resize the HRG to hold new_size leaf vertices.

Trait Implementations§

Source§

impl Clone for HrgTree

Source§

fn clone(&self) -> HrgTree

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 HrgTree

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.