@graphty/algorithms / index / CandidateOptions
Interface: CandidateOptions ​
Defined in: indexed/link-prediction.ts:48
Options of the per-node candidate functions.
Extends ​
Omit<LinkPredictionOptions,"uniquePairs">
Properties ​
candidates? ​
readonlyoptionalcandidates?:NodeSet
Defined in: indexed/link-prediction.ts:50
The nodes to consider (indices, { mask } or { ids }), in this order; default every node in index order.
directed? ​
readonlyoptionaldirected?:boolean
Defined in: indexed/common-neighbors.ts:6
Intersect out(u) with in(v) instead of the two undirected rows.
Inherited from ​
CommonNeighborsOptions.directed
includeExisting? ​
readonlyoptionalincludeExisting?:boolean
Defined in: indexed/link-prediction.ts:32
Also score pairs already joined by an arc u -> v. Default false.
Inherited from ​
LinkPredictionOptions.includeExisting
topK? ​
readonlyoptionaltopK?:number
Defined in: indexed/link-prediction.ts:38
Keep only the first topK ranked pairs. For the whole-graph predictions a value that is not positive keeps them all; for a node's candidates the default is 10 and the value is a slice end, so 0 keeps none and -2 drops the last two.