Interface HeuristicStage<A>

interface HeuristicStage<A = unknown> {
    id: string;
    weigh?: (
        candidate: HeuristicCandidate<A>,
        context: HeuristicContext,
    ) => number;
    when?: (context: HeuristicContext) => boolean;
}

Type Parameters

A = unknown

Index

Properties

id weigh? when?

Properties

id

id: string

`Optional`weigh

weigh?: (candidate: HeuristicCandidate<A>, context: HeuristicContext) => number

score one candidate; higher wins. Defaults to defaultWeigh

`Optional`when

when?: (context: HeuristicContext) => boolean

whether this stage runs at all; it always does when omitted