magpie.optimization.rankers

Class PropertyRanker

java.lang.Object

magpie.optimization.rankers.BaseEntryRanker

magpie.optimization.rankers.PropertyRanker

All Implemented Interfaces:

java.lang.Cloneable, Options

public class PropertyRanker
extends BaseEntryRanker

Shortcut for an BaseEntryRanker to operate on a certain property, rather than the default class.

Usage: <property> <ranker> [<ranker options...>]
property: Name of property used for ranking
ranker: Name of BaseEntryRanker to use
ranker options...: Options for the ranker

Field Summary

Fields

Modifier and Type	Field and Description
protected int	PropertyIndex Index of property used for ranking
protected java.lang.String	PropertyName Name of property used for ranking

Constructor Summary

Constructors

Constructor and Description
PropertyRanker()

Method Summary

Modifier and Type	Method and Description
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	setMaximizeFunction(boolean toMaximize) Set whether this entry ranker will maximize objective function
void	setOptions(java.util.List<java.lang.Object> Options) Set any options for this object.
void	setPropertyName(java.lang.String name) Set the name of property used for ranking
void	setSubRanker(BaseEntryRanker subRanker) Set the ranker employed by this class.
void	setUseMeasured(boolean useMeasured) Set whether to used measured (or predicted) class values
void	train(Dataset data) Train ranker.

Methods inherited from class magpie.optimization.rankers.BaseEntryRanker

clone, isMaximizing, isUsingMeasured, rankEntries, rankEntries, rankEntries, runObjectiveFunction, sortByRanking

Methods inherited from class java.lang.Object

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

Field Detail

PropertyName

protected java.lang.String PropertyName

Name of property used for ranking

PropertyIndex

protected int PropertyIndex

Index of property used for ranking

Constructor Detail

PropertyRanker

public PropertyRanker()

Method Detail

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

setSubRanker

public void setSubRanker(BaseEntryRanker subRanker)

Set the ranker employed by this class.

Parameters:

subRanker - Ranker used to rank by property values

setPropertyName

public void setPropertyName(java.lang.String name)

Set the name of property used for ranking

Parameters:

name - Name of property

setUseMeasured

public void setUseMeasured(boolean useMeasured)

Description copied from class: BaseEntryRanker

Set whether to used measured (or predicted) class values

Overrides:

setUseMeasured in class BaseEntryRanker

Parameters:

useMeasured - Desired option

setMaximizeFunction

public void setMaximizeFunction(boolean toMaximize)

Description copied from class: BaseEntryRanker

Set whether this entry ranker will maximize objective function

Overrides:

setMaximizeFunction in class BaseEntryRanker

Parameters:

toMaximize - Whether to maximize function

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

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