Package trade.invision.indicators.indicators.gainloss

Class Gain

java.lang.Object

trade.invision.indicators.indicators.Indicator<Num>

trade.invision.indicators.indicators.previous.PreviousDifference

trade.invision.indicators.indicators.gainloss.Gain

public class Gain
extends PreviousDifference

Gain is a Num Indicator to provide the gain of the current value compared to the n-th previous value. This will always return a positive number or zero.

Nested Class Summary

Nested classes/interfaces inherited from class trade.invision.indicators.indicators.Indicator

Indicator.CacheSeries

Field Summary

Fields inherited from class trade.invision.indicators.indicators.Indicator

cachedAddCallCount, cachedIndex, cachedValue, cacheSeries, minimumStableIndex, series

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Gain(Indicator<Num> indicator, int n)

Method Summary

Modifier and Type	Method	Description
protected Num	calculate(long index)	Performs the calculation of this Indicator at the given index.
static Gain	gain(Indicator<Num> indicator)	Calls gain(Indicator, int) with n set to 1.
static Gain	gain(Indicator<Num> indicator, int n)	Gets a Gain.

Methods inherited from class trade.invision.indicators.indicators.previous.PreviousDifference

previousDifference, previousDifference

Methods inherited from class trade.invision.indicators.indicators.Indicator

caching, getMinimumStableIndex, getSeries, getValue, isCaching, numOf, numOf, numOf, numOf, numOfEight, numOfFive, numOfFour, numOfHalf, numOfHundred, numOfHundredth, numOfNegativeOne, numOfNine, numOfOne, numOfSeven, numOfSix, numOfTen, numOfTenth, numOfThousand, numOfThousandth, numOfThree, numOfTwo, numOfZero, purgeCache

Methods inherited from class java.lang.Object

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

Constructor Details

Gain

protected Gain(Indicator<Num> indicator,
 int n)

Method Details

gain

public static Gain gain(Indicator<Num> indicator)

Calls gain(Indicator, int) with n set to 1.

gain

public static Gain gain(Indicator<Num> indicator,
 int n)

Gets a Gain.

Parameters:

indicator - the Num Indicator

n - the previous n-th value to look back at

calculate

protected Num calculate(long index)

Description copied from class: Indicator

Performs the calculation of this Indicator at the given index.

Overrides:

calculate in class PreviousDifference

Parameters:

index - the index

Returns:

the result (never null)