Returns a NumericalVariable that represents an index value relative to the specified range of base value.

Namespace: Extreme.Statistics
Assembly: Extreme.Numerics (Extreme.Numerics)

Syntax

Visual Basic (Declaration)
Public Function GetReferenceIndex ( _
	baseStartIndex As Integer, _
	baseEndIndex As Integer, _
	indexBaseValue As Double _
) As NumericalVariable
C#
public NumericalVariable GetReferenceIndex (
	int baseStartIndex,
	int baseEndIndex,
	double indexBaseValue
)
C++
public:
NumericalVariable^ GetReferenceIndex (
	int baseStartIndex, 
	int baseEndIndex, 
	double indexBaseValue
)

Parameters

baseStartIndex (System.Int32)
The zero-based index of the first reference value in the range.
baseEndIndex (System.Int32)
The zero-based index of the last reference value in the range.
indexBaseValue (System.Double)
A real number that specifies the value of the index at the base value.

Return Value

A NumericalVariable.

Remarks

The reference index is calculated relative to the sum of the observations in the specified range.

Exceptions

ExceptionCondition
ArgumentOutOfRangeExceptionbaseStartIndex is less than zero or greater than or equal to the number of observations of the variable.

-or-

baseEndIndex is less than zero or greater than or equal to the number of observations of the variable.

ArgumentExceptionbaseStartIndex is greater than baseEndIndex.