ANTAREX API

Clava API

LARA API

LARA Common Language API

(.js)
laraImport("antarex.margot.config.MargotState");

(.lara)
import antarex.margot.config.MargotState;

MargotState

Constructor

MargotState

new MargotState(name, starting)

This class represents an optimization state of the autotuner execution.

By default, metrics are combined with MargotCombination.SIMPLE.

Parameters

name: string - the name of the state
starting: boolean - whether this is a starting state

Instance Members

maximizeKnob

maximizeKnob(name, coefficient)

Adds a knob for the optimization to maximize.

Parameters

name: string - the name of the knob
coefficient: Number - the coefficient to use when combining metrics/knobs

maximizeMetric

maximizeMetric(name, coefficient)

Adds a metric for the optimization to maximize.

Parameters

name: string - the name of the metric
coefficient: Number - the coefficient to use when combining metrics/knobs

minimizeKnob

minimizeKnob(name, coefficient)

Adds a knob for the optimization to minimize.

Parameters

name: string - the name of the knob
coefficient: Number - the coefficient to use when combining metrics/knobs

minimizeMetric

minimizeMetric(name, coefficient)

Adds a metric for the optimization to minimize.

Parameters

name: string - the name of the metric
coefficient: Number - the coefficient to use when combining metrics/knobs

setMaximizeCombination

setMaximizeCombination(combination)

Sets the combination for the metrics that will be maximized.

Parameters

combination: MargotCombination - the combination kind

setMinimizeCombination

setMinimizeCombination(combination)

Sets the combination for the metrics that will be minimized.

Parameters

combination: MargotCombination - the combination kind

setStarting

setStarting(starting)

Sets whether this is the starting state or not.

Parameters

starting: boolean - whether this is a starting state

subjectTo

subjectTo(goalName, confidence, priority)

Adds a constraint to the state.

Parameters

goalName: string - the name of the goal
confidence: Number - the confidence level of the constraint
priority: Number - the priority of the constraint