Skip to main content

BarabasiOptions

Struct BarabasiOptions 

Source
pub struct BarabasiOptions<'a> {
    pub power: f64,
    pub m: usize,
    pub outseq: Option<&'a [i64]>,
    pub outpref: bool,
    pub a: f64,
    pub directed: bool,
    pub algorithm: BarabasiAlgorithm,
    pub start_from: Option<&'a Graph>,
}
Expand description

Options of Graph::barabasi_game, with the defaults of the classic undirected Barabási–Albert model (m = 1, power = 1, A = 1, BarabasiAlgorithm::Psumtree).

use igraph::prelude::*;
use igraph::games::BarabasiOptions;

let opts = BarabasiOptions::default().with_m(3).with_directed(true).with_power(0.5);
assert_eq!((opts.m, opts.directed, opts.power), (3, true, 0.5));

Fields§

§power: f64

Exponent of the preferential attachment: the probability of citing a vertex of degree d is proportional to d^power + a (default 1).

§m: usize

Number of edges added with each new vertex, used when outseq is None (default 1).

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

Explicit number of edges added with each vertex (the first entry is ignored, as the first vertex cannot cite anybody). With start_from, it refers only to the newly added vertices. Default None.

§outpref: bool

Whether the out-degree also counts in the attractiveness (i.e. total degree instead of in-degree). Ignored (assumed true) for undirected graphs. Default false.

§a: f64

The constant attractiveness A of vertices (default 1).

§directed: bool

Whether to create a directed graph (default false).

§algorithm: BarabasiAlgorithm

The sampling algorithm (default BarabasiAlgorithm::Psumtree, that creates simple graphs).

§start_from: Option<&'a Graph>

An optional non-empty starting graph; by default the process starts from a single vertex (the C documentation mentions a clique of size m, but the implementation starts from one vertex in igraph 1.0.0 and 1.0.1). The generated graph contains it as its first vertices and edges.

Implementations§

Source§

impl<'a> BarabasiOptions<'a>

Source

pub fn with_power(self, power: f64) -> Self

Sets power.

Source

pub fn with_m(self, m: usize) -> Self

Sets m.

Source

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

Sets outseq.

Source

pub fn with_outpref(self, outpref: bool) -> Self

Sets outpref.

Source

pub fn with_a(self, a: f64) -> Self

Sets the constant attractiveness a.

Source

pub fn with_directed(self, directed: bool) -> Self

Sets directed.

Source

pub fn with_algorithm(self, algorithm: BarabasiAlgorithm) -> Self

Sets algorithm.

Source

pub fn with_start_from(self, start_from: &'a Graph) -> Self

Sets start_from.

Trait Implementations§

Source§

impl<'a> Clone for BarabasiOptions<'a>

Source§

fn clone(&self) -> BarabasiOptions<'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 BarabasiOptions<'a>

Source§

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

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

impl Default for BarabasiOptions<'_>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<'a> !Send for BarabasiOptions<'a>

§

impl<'a> !Sync for BarabasiOptions<'a>

§

impl<'a> Freeze for BarabasiOptions<'a>

§

impl<'a> RefUnwindSafe for BarabasiOptions<'a>

§

impl<'a> Unpin for BarabasiOptions<'a>

§

impl<'a> UnsafeUnpin for BarabasiOptions<'a>

§

impl<'a> UnwindSafe for BarabasiOptions<'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.