Graphty

Appearance

@graphty/graphty-element / session / Caveats

Interface: Caveats ​

Defined in: graphty-element/src/session/runs/types.ts:209

What qualifies a run's numbers.

Caveats travel with the result rather than sitting in a graph-level bag of facts, because two runs of the same algorithm on the same graph can differ in every one of them. A consumer comparing a value against a saved one, or ranking two nodes whose scores are within a rounding error, reads the qualification from the same object that carries the value.

precision is the clearest case: a run on an accelerator computes in single precision and reports "f32", a run on the CPU path reports "f64", and without it "why does this number disagree with the one I had a minute ago" has no answer.

Properties ​

componentScope? ​

readonly optional componentScope?: "all" | "largest"

Defined in: graphty-element/src/session/runs/types.ts:221

Whether the run covered every component or only the largest.

converged? ​

readonly optional converged?: boolean

Defined in: graphty-element/src/session/runs/types.ts:217

Whether an iterative algorithm reached its convergence threshold.

direction ​

readonly direction: RunDirection

Defined in: graphty-element/src/session/runs/types.ts:227

How edge direction was treated.

exact ​

readonly exact: boolean

Defined in: graphty-element/src/session/runs/types.ts:211

Whether the numbers are exact, or an approximation the element chose above the cost cap.

filterScope? ​

readonly optional filterScope?: boolean

Defined in: graphty-element/src/session/runs/types.ts:223

Whether a visibility filter narrowed what the run looked at.

iterations? ​

readonly optional iterations?: number

Defined in: graphty-element/src/session/runs/types.ts:219

How many iterations it took.

method ​

readonly method: string

Defined in: graphty-element/src/session/runs/types.ts:233

Which method computed them, such as "dijkstra" or "brandes-sampled".

notes ​

readonly notes: readonly string[]

Defined in: graphty-element/src/session/runs/types.ts:241

Anything else a reader should know, in sentences.

partialReason? ​

readonly optional partialReason?: string

Defined in: graphty-element/src/session/runs/types.ts:239

Why a run stopped before it finished, when it did. Present exactly when the run resolved with partial set, whatever stopped it: a time box, a cancellation, or the algorithm's own iteration cap.

precision ​

readonly precision: Precision

Defined in: graphty-element/src/session/runs/types.ts:231

The arithmetic that produced these numbers.

sampleSize? ​

readonly optional sampleSize?: number

Defined in: graphty-element/src/session/runs/types.ts:213

How many elements the approximation sampled. Present only when exact is false.

seed? ​

readonly optional seed?: number | null

Defined in: graphty-element/src/session/runs/types.ts:215

The seed a sampled or randomised run used, so it can be reproduced.

weight? ​

readonly optional weight?: WeightMeaning | null

Defined in: graphty-element/src/session/runs/types.ts:229

What the edge weight was taken to mean, or null when the run ignored weights.

windowScope? ​

readonly optional windowScope?: boolean

Defined in: graphty-element/src/session/runs/types.ts:225

Whether a time window narrowed what the run looked at.