Skip to main content

PageRankOptions

Struct PageRankOptions 

Source
pub struct PageRankOptions {
    pub damping: f64,
    pub directed: bool,
    pub algo: PageRankAlgo,
}
Expand description

Tuning parameters of the PageRank family of functions (pagerank, personalized_pagerank, personalized_pagerank_vs).

The Default is the classic setting: damping 0.85, directed paths, PageRankAlgo::Prpack.

use igraph::centrality::{PageRankAlgo, PageRankOptions};

let opts = PageRankOptions::default().with_damping(0.5).with_algo(PageRankAlgo::Arpack);
assert_eq!((opts.damping, opts.directed, opts.algo), (0.5, true, PageRankAlgo::Arpack));

Fields§

§damping: f64

The damping factor (d in the original paper): the probability that the random walker follows an edge instead of restarting. Must be in [0, 1].

§directed: bool

Whether to follow edge directions in directed graphs (ignored for undirected graphs).

§algo: PageRankAlgo

The implementation to use.

Implementations§

Source§

impl PageRankOptions

Source

pub fn with_damping(self, damping: f64) -> Self

Sets the damping factor.

Source

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

Sets whether edge directions are followed (directed).

Source

pub fn with_algo(self, algo: PageRankAlgo) -> Self

Sets the implementation (algo).

Trait Implementations§

Source§

impl Clone for PageRankOptions

Source§

fn clone(&self) -> PageRankOptions

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 Copy for PageRankOptions

Source§

impl Debug for PageRankOptions

Source§

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

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

impl Default for PageRankOptions

Source§

fn default() -> Self

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

impl PartialEq for PageRankOptions

Source§

fn eq(&self, other: &PageRankOptions) -> 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 StructuralPartialEq for PageRankOptions

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.