magpie.optimization.rankers

Class TargetEntryRanker

java.lang.Object

magpie.optimization.rankers.BaseEntryRanker

magpie.optimization.rankers.TargetEntryRanker

All Implemented Interfaces:

java.lang.Cloneable, Options

public class TargetEntryRanker
extends BaseEntryRanker

Rank entries based on the distance of their class variable from a target.

Usage: <target>
target: Target value used when ranking entries

Field Summary

Fields

Modifier and Type	Field and Description
protected double	Target Target value of class

Constructor Summary

Constructors

Constructor and Description
TargetEntryRanker() Create a new instance the target set to 0.0
TargetEntryRanker(double Target) Create a new instance while specifying the target

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	setOptions(java.util.List Options) Set any options for this object.
void	train(Dataset data) Train ranker.

Methods inherited from class magpie.optimization.rankers.BaseEntryRanker

clone, 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

Field Detail

Target

protected double Target

Target value of class

Constructor Detail

TargetEntryRanker

public TargetEntryRanker(double Target)

Create a new instance while specifying the target

Parameters:

Target - Target value for class variable

TargetEntryRanker

public TargetEntryRanker()

Create a new instance the target set to 0.0

Method Detail

setOptions

public void setOptions(java.util.List 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

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

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