org.encog.app.quant.indicators.predictive

Class BestReturn

java.lang.Object

org.encog.app.analyst.csv.basic.BaseCachedColumn

org.encog.app.quant.indicators.Indicator

org.encog.app.quant.indicators.predictive.BestReturn

public class BestReturn
extends Indicator

Get the best return.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME The name of this indicator.

Constructor Summary

Constructors

Constructor and Description
BestReturn(int thePeriods, boolean output) Construct the object.

Method Summary

Modifier and Type	Method and Description
void	calculate(java.util.Map<java.lang.String,BaseCachedColumn> data, int length) Calculate the indicator.
int	getPeriods()

Methods inherited from class org.encog.app.quant.indicators.Indicator

getBeginningIndex, getEndingIndex, require, setBeginningIndex, setEndingIndex

Methods inherited from class org.encog.app.analyst.csv.basic.BaseCachedColumn

allocate, getData, getName, isIgnore, isInput, isOutput, setIgnore, setInput, setName, setOutput

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

The name of this indicator.

See Also:

Constant Field Values

Constructor Detail

BestReturn

public BestReturn(int thePeriods,
                  boolean output)

Construct the object.

Parameters:

thePeriods - The number of periods.

output - True, if this indicator is to be predicted.

Method Detail

calculate

public final void calculate(java.util.Map<java.lang.String,BaseCachedColumn> data,
                            int length)

Calculate the indicator.

Specified by:

calculate in class Indicator

Parameters:

data - The data available to the indicator.

length - The length of the data to calculate.

getPeriods

public final int getPeriods()

Specified by:

getPeriods in class Indicator

Returns:

The number of periods.