Skip to content

@graphty/algorithms / index / PageRankOptions

Interface: PageRankOptions ​

Defined in: indexed/pagerank.ts:6

Options of the index-based PageRank (graph-format design 14.2 Port 3).

Properties ​

convergenceNorm? ​

readonly optional convergenceNorm?: "max" | "l1"

Defined in: indexed/pagerank.ts:21

How the per-iteration change is measured against tolerance: "l1" (default) sums it over all nodes, "max" takes the largest single-node change, the legacy pageRank rule.


dampingFactor? ​

readonly optional dampingFactor?: number

Defined in: indexed/pagerank.ts:8

Probability of following a link; default 0.85.


initialRanks? ​

readonly optional initialRanks?: F64 | F32

Defined in: indexed/pagerank.ts:16

Starting rank per node index, normalised to sum 1 (when the sum is positive); default uniform.


maxIterations? ​

readonly optional maxIterations?: number

Defined in: indexed/pagerank.ts:10

Iteration cap; default 100.


tolerance? ​

readonly optional tolerance?: number

Defined in: indexed/pagerank.ts:12

Convergence tolerance on the per-iteration change; default 1e-6.


weighted? ​

readonly optional weighted?: boolean

Defined in: indexed/pagerank.ts:14

Use the snapshot's arc weights; default false.