Struct PageRankConfig 

#[non_exhaustive]
pub struct PageRankConfig<S> {
    pub damping: S,
    pub tolerance: S,
    pub max_iterations: usize,
}

PageRank configuration shared by graph and hypergraph policies.

Performance

Copying and debug-formatting are O(1).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

damping: S

Damping factor, usually 0.85.

tolerance: S

L1 convergence tolerance.

max_iterations: usize

Maximum power-iteration count.

Implementations

impl<S> PageRankConfig<S>

pub const fn new( damping: S, tolerance: S, max_iterations: usize, ) -> PageRankConfig<S>

Constructs a PageRank configuration.

Validation is performed by the PageRank entry point so callers can build configs before deciding which algorithm variant to invoke.

Performance

This function is O(1).

Trait Implementations

impl<S> Clone for PageRankConfig<S>

where S: Clone,

fn clone(&self) -> PageRankConfig<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> Copy for PageRankConfig<S>

where S: Copy,

impl<S> Debug for PageRankConfig<S>

where S: Debug,

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

Formats the value using the given formatter.

impl<S> PartialEq for PageRankConfig<S>

where S: PartialEq,

fn eq(&self, other: &PageRankConfig<S>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<S> StructuralPartialEq for PageRankConfig<S>