Struct AlgoParams 

pub struct AlgoParams {
    pub collection: String,
    pub edge_label: Option<String>,
    pub damping: Option<f64>,
    pub max_iterations: Option<usize>,
    pub tolerance: Option<f64>,
    pub source_node: Option<String>,
    pub sample_size: Option<usize>,
    pub direction: Option<String>,
    pub resolution: Option<f64>,
    pub mode: Option<String>,
    pub personalization_vector: Option<HashMap<String, f64>>,
}

Generic parameter bag for all graph algorithms.

Each algorithm validates and extracts the parameters it needs, ignoring the rest. Unknown parameters are silently ignored rather than rejected — this allows forward-compatible DDL extensions.

Fields

collection: String

Target collection name.

edge_label: Option<String>

Optional edge label filter — only edges with this label are traversed.

damping: Option<f64>

PageRank damping factor (default: 0.85).

max_iterations: Option<usize>

Maximum iterations for iterative algorithms (PageRank, LabelProp, Louvain).

tolerance: Option<f64>

Convergence tolerance for PageRank (default: 1e-7).

source_node: Option<String>

Source node for SSSP.

sample_size: Option<usize>

Sample size for approximate centrality (betweenness, closeness). None = exact computation.

direction: Option<String>

Direction for degree centrality: “in”, “out”, “both”.

resolution: Option<f64>

Resolution parameter for Louvain (default: 1.0).

mode: Option<String>

Mode for triangle counting / diameter: “global”, “per_node”, “exact”, “approximate”.

personalization_vector: Option<HashMap<String, f64>>

Per-node initial rank seed for Personalized PageRank.

When None, PageRank initializes uniformly (1.0/n per node) — standard behavior. When Some(map), PPR initializes each node id to map[id] (normalized to sum=1.0); nodes missing from the map start at 0.0. Bias toward seed nodes makes them and their neighbors rank higher.

Implementations

impl AlgoParams

pub fn damping_factor(&self) -> f64

PageRank damping factor, validated to (0.0, 1.0).

pub fn iterations(&self, default: usize) -> usize

Max iterations with sensible default per algorithm.

Defence-in-depth: the pgwire handler clamps ITERATIONS to MAX_ITERATIONS_CAP before dispatch, but any alternate entry point (native protocol, internal dispatch) also lands here, so we enforce the ceiling at the engine boundary too.

pub fn convergence_tolerance(&self) -> f64

Convergence tolerance, validated to positive.

pub fn louvain_resolution(&self) -> f64

Louvain resolution parameter, validated to positive.

pub fn personalization_vector(&self) -> Option<&HashMap<String, f64>>

Personalization vector for Personalized PageRank.

Returns None for standard uniform-init PageRank, or Some(map) where map keys are node ids and values are unnormalized seed weights.

Trait Implementations

impl Clone for AlgoParams

fn clone(&self) -> AlgoParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AlgoParams

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

Formats the value using the given formatter.

impl Default for AlgoParams

fn default() -> AlgoParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AlgoParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'__msgpack_de> FromMessagePack<'__msgpack_de> for AlgoParams

fn read<R: Read<'__msgpack_de>>(reader: &mut R) -> Result<Self, Error>

where Self: Sized,

Reads the MessagePack representation of this value from the provided reader.

impl PartialEq for AlgoParams

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AlgoParams

impl ToMessagePack for AlgoParams

fn write<W: Write>(&self, writer: &mut W) -> Result<(), Error>

Writes the MessagePack representation of this value into the provided writer.