Appearance

@graphty/algorithms / index / AlgorithmAccelerator

Interface: AlgorithmAccelerator ​

Defined in: indexed/accelerator.ts:137

The structural contract an injected accelerator satisfies. EVERY member except kind is optional: an accelerator declares only what it implements, and the dispatcher runs the CPU port for everything else. The list is the design's, in full, so that an accelerator written against it needs no change as the ports land.

Properties ​

harmonicCloseness? ​

readonly optional harmonicCloseness?: boolean

Defined in: indexed/accelerator.ts:161

True when closenessCentrality honours harmonic on an exact run; absent, harmonic closeness runs on the CPU.

kind ​

readonly kind: string

Defined in: indexed/accelerator.ts:138

Methods ​

allPairsShortestPath()? ​

optional allPairsShortestPath(s, options?): Promise<ApspResultLike>

Defined in: indexed/accelerator.ts:170

Parameters ​

s ​

GraphSnapshot

options? ​

SsspOptions

Returns ​

Promise<ApspResultLike>

bellmanFord()? ​

optional bellmanFord(s, source, options?): Promise<BellmanFordResultLike>

Defined in: indexed/accelerator.ts:158

Parameters ​

s ​

GraphSnapshot

source ​

number

options? ​

SsspOptions

Returns ​

Promise<BellmanFordResultLike>

betweennessCentrality()? ​

optional betweennessCentrality(s, options?): Promise<ScoresResultLike & PathCountReport>

Defined in: indexed/accelerator.ts:162

Parameters ​

s ​

GraphSnapshot

options? ​

BetweennessAcceleratorOptions

Returns ​

Promise<ScoresResultLike & PathCountReport>

breadthFirstSearch()? ​

optional breadthFirstSearch(s, source, options?): Promise<BfsResultLike>

Defined in: indexed/accelerator.ts:152

Parameters ​

s ​

GraphSnapshot

source ​

number

options? ​

Pick<BfsOptions, "maxDepth">

Returns ​

Promise<BfsResultLike>

closenessCentrality()? ​

optional closenessCentrality(s, options?): Promise<ClosenessResultLike>

Defined in: indexed/accelerator.ts:159

Parameters ​

s ​

GraphSnapshot

options? ​

ClosenessAcceleratorOptions

Returns ​

Promise<ClosenessResultLike>

connectedComponents()? ​

optional connectedComponents(s): Promise<LabelResultLike>

Defined in: indexed/accelerator.ts:148

Parameters ​

s ​

GraphSnapshot

Returns ​

Promise<LabelResultLike>

dispose()? ​

optional dispose(): void

Defined in: indexed/accelerator.ts:177

Returns ​

void

edgeBetweennessCentrality()? ​

optional edgeBetweennessCentrality(s, options?): Promise<EdgeScoresResultLike & PathCountReport>

Defined in: indexed/accelerator.ts:166

Parameters ​

s ​

GraphSnapshot

options? ​

BetweennessAcceleratorOptions

Returns ​

Promise<EdgeScoresResultLike & PathCountReport>

eigenvectorCentrality()? ​

optional eigenvectorCentrality(s, options?): Promise<ScoresResultLike>

Defined in: indexed/accelerator.ts:146

Parameters ​

s ​

GraphSnapshot

options? ​

HitsOptionsLike

Returns ​

Promise<ScoresResultLike>

hits()? ​

optional hits(s, options?): Promise<HitsResultLike>

Defined in: indexed/accelerator.ts:145

Parameters ​

s ​

GraphSnapshot

options? ​

HitsOptionsLike

Returns ​

Promise<HitsResultLike>

katzCentrality()? ​

optional katzCentrality(s, options?): Promise<ScoresResultLike>

Defined in: indexed/accelerator.ts:147

Parameters ​

s ​

GraphSnapshot

options? ​

KatzOptionsLike

Returns ​

Promise<ScoresResultLike>

kCoreDecomposition()? ​

optional kCoreDecomposition(s): Promise<CorenessResultLike>

Defined in: indexed/accelerator.ts:171

Parameters ​

s ​

GraphSnapshot

Returns ​

Promise<CorenessResultLike>

labelPropagation()? ​

optional labelPropagation(s, options?): Promise<LabelResultLike>

Defined in: indexed/accelerator.ts:173

Parameters ​

s ​

GraphSnapshot

options? ​

HitsOptionsLike

Returns ​

Promise<LabelResultLike>

louvain()? ​

optional louvain(s, options?): Promise<CommunityResultLike>

Defined in: indexed/accelerator.ts:175

Parameters ​

s ​

GraphSnapshot

options? ​

HitsOptionsLike

Returns ​

Promise<CommunityResultLike>

minimumSpanningTree()? ​

optional minimumSpanningTree(s, options?): Promise<MstResultLike>

Defined in: indexed/accelerator.ts:174

Parameters ​

s ​

GraphSnapshot

options? ​

MstOptions

Returns ​

Promise<MstResultLike>

pageRank()? ​

optional pageRank(s, options?): Promise<PageRankResultLike>

Defined in: indexed/accelerator.ts:139

Parameters ​

s ​

GraphSnapshot

options? ​

PageRankOptionsLike

Returns ​

Promise<PageRankResultLike>

personalizedPageRank()? ​

optional personalizedPageRank(s, personalization, options?): Promise<PageRankResultLike>

Defined in: indexed/accelerator.ts:140

Parameters ​

s ​

GraphSnapshot

personalization ​

F64 | F32

options? ​

PageRankOptionsLike

Returns ​

Promise<PageRankResultLike>

release()? ​

optional release(s): void

Defined in: indexed/accelerator.ts:176

Parameters ​

s ​

GraphSnapshot

Returns ​

void

sssp()? ​

optional sssp(s, source, options?): Promise<SsspResultLike>

Defined in: indexed/accelerator.ts:157

Parameters ​

s ​

GraphSnapshot

source ​

number

options? ​

SsspOptions

Returns ​

Promise<SsspResultLike>

triangleCount()? ​

optional triangleCount(s): Promise<{ perNode: U32; total: number; }>

Defined in: indexed/accelerator.ts:172

Parameters ​

s ​

GraphSnapshot

Returns ​

Promise<{ perNode: U32; total: number; }>

weaklyConnectedComponents()? ​

optional weaklyConnectedComponents(s): Promise<LabelResultLike>

Defined in: indexed/accelerator.ts:149

Parameters ​

s ​

GraphSnapshot

Returns ​

Promise<LabelResultLike>