magpie.optimization.rankers

Class PropertyFormulaRanker

java.lang.Object

magpie.optimization.rankers.BaseEntryRanker

magpie.optimization.rankers.MultiObjectiveEntryRanker

magpie.optimization.rankers.PropertyFormulaRanker

All Implemented Interfaces:

java.lang.Cloneable, Options

public class PropertyFormulaRanker
extends MultiObjectiveEntryRanker

Use a formula of several properties. Requires that entries are instances of MultiPropertyEntry.

Usage: <formula...>
formula: Formula to use as objective function. Property names must be surrounded by #{}'s.
Example formula: #{volume_pa} * #{bandgap}

Constructor Summary

Constructors

Constructor and Description
PropertyFormulaRanker()

Method Summary

Modifier and Type	Method and Description
PropertyFormulaRanker	clone()
protected java.lang.String	extractVariables(java.lang.String Formula) Parse a formula to find names of properties used as variables.
java.lang.String[]	getObjectives() Get properties currently used in objective functions.
double	objectiveFunction(BaseEntry Entry) Some kind of objective function that returns a double when given an entry.
java.lang.String	printUsage() Print out required format for options.
void	setFormula(java.lang.String formula) Define the formula used by this class.
void	setOptions(java.util.List<java.lang.Object> Options) Set any options for this object.
void	train(MultiPropertyDataset data) Train the entry ranker.

Methods inherited from class magpie.optimization.rankers.MultiObjectiveEntryRanker

train

Methods inherited from class magpie.optimization.rankers.BaseEntryRanker

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyFormulaRanker

public PropertyFormulaRanker()

Method Detail

clone

public PropertyFormulaRanker clone()

Overrides:

clone in class MultiObjectiveEntryRanker

setOptions

public void setOptions(java.util.List<java.lang.Object> Options)
                throws java.lang.Exception

Description copied from interface: Options

Set any options for this object. If parsing the options fails, return an Exception with the usage as its message.

Parameters:

Options - Array of options as Objects - can be null

Throws:

java.lang.Exception - if problem with inputs

printUsage

public java.lang.String printUsage()

Description copied from interface: Options

Print out required format for options. For consistency, should start with "Usage: ".

Returns:

Usage for this function

train

public void train(MultiPropertyDataset data)

Description copied from class: MultiObjectiveEntryRanker

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)

Specified by:

train in class MultiObjectiveEntryRanker

Parameters:

data - Dataset to use for training

getObjectives

public java.lang.String[] getObjectives()

Description copied from class: MultiObjectiveEntryRanker

Get properties currently used in objective functions.

Specified by:

getObjectives in class MultiObjectiveEntryRanker

Returns:

Array of properties currently in use

setFormula

public void setFormula(java.lang.String formula)
                throws java.lang.Exception

Define the formula used by this class. Names of properties used in the calculation should be surrounded #{}'s.

Parameters:

formula - Formula to be used

Throws:

java.lang.Exception - If parsing fails

extractVariables

protected java.lang.String extractVariables(java.lang.String Formula)
                                     throws java.lang.Exception

Parse a formula to find names of properties used as variables. They should be surrounded by #{}'s. Stores result internally.

Parameters:

Formula - Formula to be parsed

Returns:

Formula in a form parsable by Expr

Throws:

java.lang.Exception

objectiveFunction

public double objectiveFunction(BaseEntry Entry)

Description copied from class: BaseEntryRanker

Some kind of objective function that returns a double when given an entry.

NOTE: This function needs to support using either the measured or predicted class depending on the settings

Specified by:

objectiveFunction in class BaseEntryRanker

Parameters:

Entry - Entry to be analyzed

Returns:

Evaluation of target function