magpie.optimization.rankers

Class MultiObjectiveEntryRanker

java.lang.Object

magpie.optimization.rankers.BaseEntryRanker

magpie.optimization.rankers.MultiObjectiveEntryRanker

All Implemented Interfaces:

java.lang.Cloneable, Options

Direct Known Subclasses:

AdaptiveScalarizingEntryRanker, PropertyFormulaRanker

public abstract class MultiObjectiveEntryRanker
extends BaseEntryRanker

Base class for multi-objective entry rankers. Users need to specify the following operations:

• {@linkplain #train(magpie.data.MultiPropertyDataset) ) - Run necessary calculations

Constructor Summary

Constructors

Constructor and Description
MultiObjectiveEntryRanker()

Method Summary

Modifier and Type	Method and Description
MultiObjectiveEntryRanker	clone()
abstract java.lang.String[]	getObjectives() Get properties currently used in objective functions.
void	train(Dataset data) Train ranker.
abstract void	train(MultiPropertyDataset data) Train the entry ranker.

Methods inherited from class magpie.optimization.rankers.BaseEntryRanker

isMaximizing, isUsingMeasured, objectiveFunction, rankEntries, rankEntries, rankEntries, runObjectiveFunction, setMaximizeFunction, setUseMeasured, sortByRanking

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface magpie.utility.interfaces.Options

printUsage, setOptions

Constructor Detail

MultiObjectiveEntryRanker

public MultiObjectiveEntryRanker()

Method Detail

clone

public MultiObjectiveEntryRanker clone()

Overrides:

clone in class BaseEntryRanker

train

public abstract void train(MultiPropertyDataset data)

Train the entry ranker. This may be necessary for multi-objective methods that rely on the performance of other entries (e.g. Pareto fronts).

Note: This might be an opportune operation to map the name of each property with their index to allow for faster operation of the EntryRanker#objectiveFunction(magpie.data.BaseEntry)

Parameters:

data - Dataset to use for training

getObjectives

public abstract java.lang.String[] getObjectives()

Get properties currently used in objective functions.

Returns:

Array of properties currently in use

train

public void train(Dataset data)

Description copied from class: BaseEntryRanker

Train ranker.

Specified by:

train in class BaseEntryRanker

Parameters:

data - Data to use as training set