Skip to main content

GraphAlgorithmParams

Enum GraphAlgorithmParams 

Source
pub enum GraphAlgorithmParams {
Show 24 variants PageRank(GraphPageRankParams), PersonalizedPageRank(GraphPersonalizedPageRankParams), Bfs(Box<GraphBfsParams>), Louvain(GraphLouvainParams), EigenvectorCentrality(GraphEigenvectorCentralityParams), KatzCentrality(GraphKatzCentralityParams), Hits(GraphHitsParams), BetweennessCentrality(GraphBetweennessCentralityParams), EdgeBetweennessCentrality(GraphEdgeBetweennessCentralityParams), Sssp(GraphSsspParams), DegreesAll(GraphDegreesAllParams), InDegreesAll(GraphInDegreesAllParams), OutDegreesAll(GraphOutDegreesAllParams), WeaklyConnectedComponents(GraphWccParams), StronglyConnectedComponents(GraphSccParams), TriangleCountAll(GraphTriangleCountAllParams), CoreNumber(GraphCoreNumberParams), KCore(GraphKCoreParams), MinimumSpanningTree(GraphMstParams), Leiden(GraphLeidenParams), Ecg(GraphEcgParams), SpectralModularityMaximization(GraphSpectralClusteringParams), ForceAtlas2(GraphForceAtlas2Params), Similarity(GraphSimilarityParams),
}
Expand description

Algorithm-specific parameters.

Variants§

§

PageRank(GraphPageRankParams)

PageRank damping, convergence tolerance, and iteration cap.

§

PersonalizedPageRank(GraphPersonalizedPageRankParams)

PageRank solver options with a relation-backed personalization vector.

§

Bfs(Box<GraphBfsParams>)

Breadth-first traversal source, depth bound, predicates, and optional path output.

§

Louvain(GraphLouvainParams)

Louvain modularity optimization controls.

§

EigenvectorCentrality(GraphEigenvectorCentralityParams)

Power-iteration tolerance and cap for vertex eigenvector scores.

§

KatzCentrality(GraphKatzCentralityParams)

Attenuation, constant contribution, and convergence controls for Katz scores.

§

Hits(GraphHitsParams)

Convergence controls and optional normalization for hub and authority scores.

§

BetweennessCentrality(GraphBetweennessCentralityParams)

Vertex betweenness seed selection, normalization, and endpoint inclusion.

§

EdgeBetweennessCentrality(GraphEdgeBetweennessCentralityParams)

Edge betweenness seed selection and normalization.

§

Sssp(GraphSsspParams)

Single-source weighted shortest-path source and optional distance cutoff.

§

DegreesAll(GraphDegreesAllParams)

Request both incoming and outgoing degree counts for every vertex.

§

InDegreesAll(GraphInDegreesAllParams)

Request incoming degree counts for every vertex.

§

OutDegreesAll(GraphOutDegreesAllParams)

Request outgoing degree counts for every vertex.

§

WeaklyConnectedComponents(GraphWccParams)

Label vertices connected when edge direction is ignored.

§

StronglyConnectedComponents(GraphSccParams)

Label vertices mutually reachable along directed edges.

§

TriangleCountAll(GraphTriangleCountAllParams)

Count triangles incident to every vertex.

§

CoreNumber(GraphCoreNumberParams)

Select the degree convention used to compute vertex core numbers.

§

KCore(GraphKCoreParams)

Select the minimum core degree and degree convention for the returned edge list.

§

MinimumSpanningTree(GraphMstParams)

Request a minimum-weight spanning edge list without additional solver options.

§

Leiden(GraphLeidenParams)

Leiden community resolution, iteration bound, and random seed.

§

Ecg(GraphEcgParams)

Ensemble clustering weights, ensemble size, modularity controls, and random seed.

§

SpectralModularityMaximization(GraphSpectralClusteringParams)

Spectral clustering count, eigensolver tolerance, and random seed.

§

ForceAtlas2(GraphForceAtlas2Params)

ForceAtlas2 iteration controls and optional per-vertex attributes and initial positions.

§

Similarity(GraphSimilarityParams)

Explicit vertex-pair relation shared by Jaccard, Sorensen, overlap, and cosine metrics.

Implementations§

Source§

impl GraphAlgorithmParams

Source

pub const fn supports_algorithm(&self, algorithm: GraphAlgorithm) -> bool

Whether this payload is valid for an algorithm variant.

Similarity deliberately has one shared payload for four metric identities. The metric stays in GraphAlgorithm so the pair side input and its validation cannot drift across copied parameter variants.

Source

pub fn side_input_ordinals(&self) -> Box<dyn Iterator<Item = usize> + '_>

Visits every relation-backed side-input ordinal in stable execution order.

Trait Implementations§

Source§

impl Clone for GraphAlgorithmParams

Source§

fn clone(&self) -> Self

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 GraphAlgorithmParams

Source§

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

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

impl PartialEq for GraphAlgorithmParams

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for GraphAlgorithmParams

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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> Same for T

Source§

type Output = T

Should always be Self
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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.