Skip to main content

PageRankConfig

Struct PageRankConfig 

Source
pub struct PageRankConfig {
    pub damping_factor: f64,
    pub max_iterations: usize,
    pub tolerance: f64,
    pub normalize: bool,
    pub max_graph_nodes: Option<usize>,
}
Expand description

Configuration for PageRank algorithm.

Fields§

§damping_factor: f64

Damping factor (probability of following a link vs random jump). Default: 0.85

§max_iterations: usize

Maximum number of iterations before stopping. Default: 100

§tolerance: f64

Convergence tolerance. Algorithm stops when max score change < tolerance. Default: 1e-6

§normalize: bool

Whether to normalize scores to sum to 1.0. Default: true

§max_graph_nodes: Option<usize>

Maximum number of nodes allowed before returning an error. Set to None to disable the check. Default: 10,000,000 (10M nodes)

Implementations§

Source§

impl PageRankConfig

Source

pub fn new() -> Self

Create a new configuration with default values.

Source

pub const fn with_damping_factor(self, damping_factor: f64) -> Self

Set the damping factor.

The damping factor represents the probability that a random walker follows a link instead of jumping to a random node. Common values are 0.85 (default) or 0.9.

Source

pub const fn with_max_iterations(self, max_iterations: usize) -> Self

Set the maximum number of iterations.

Source

pub const fn with_tolerance(self, tolerance: f64) -> Self

Set the convergence tolerance.

The algorithm stops when the maximum change in any node’s score between iterations is less than this value.

Source

pub const fn with_normalize(self, normalize: bool) -> Self

Set whether to normalize scores to sum to 1.0.

Source

pub const fn with_max_graph_nodes(self, limit: Option<usize>) -> Self

Set the maximum number of nodes allowed.

If the graph has more nodes than this limit, the algorithm will return a GraphError::GraphTooLarge error instead of attempting to allocate potentially gigabytes of memory.

Set to None to disable the check (use with caution).

Trait Implementations§

Source§

impl Clone for PageRankConfig

Source§

fn clone(&self) -> PageRankConfig

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 Debug for PageRankConfig

Source§

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

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

impl Default for PageRankConfig

Source§

fn default() -> Self

Returns the “default value” for a type. 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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more