Click or drag to resize
Accord.NET (logo)

MeasuresExponentialWeightedMean Method (Double, Int32, Double)
Calculates the exponentially weighted mean.

Namespace:  Accord.Statistics
Assembly:  Accord.Math (in Accord.Math.dll) Version: 3.8.0
Syntax
Copy
public static double ExponentialWeightedMean(
	this double[] values,
	int window,
	double alpha = 0
)
Request Example View Source

Parameters

values
Type: SystemDouble
A vector of observations whose EW mean will be calculated. It is assumed that the vector is ordered with the most recent observations at the end of the vector (and the oldest observations at the start).
window
Type: SystemInt32
The number of samples to be used in the calculation.
alpha (Optional)
Type: SystemDouble
The weighting to be applied to the calculation. A higher alpha discounts older observations faster. Alpha must be between 0 and 1 (inclusive).

Return Value

Type: Double
Returns a Double giving the exponentially weighted average of the vector.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type . When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Examples

The following example shows how to compute the EW mean.

Copy
/*
Suppose we have a time series of observations. Our sample has 17 
observations. We wish to compute the mean for our series but would 
like to provide a heavier weighting to the more recent observations. 
First, create a vector with the oldest data at the start and the most
recent data at the end of the vector. */
double[] timeSeries =
{
    2, 2, 1, 3, 5, 6, 4, 2, 7, 8, 9, 2, 3, 4, 5, 6, 7
};

// The window size determines how many observations to include in the 
// calculation. If no window is specified, the entire dataset is used. 
int window = 15;

// We set alpha to 20% meaning each previous observation's contribution 
// carries 20% less weight (relative to its immediate successor).  
double alpha = 0.2;

// Now we calculate the EW mean. The result should be 5.37
double ewm = timeSeries.ExponentialWeightedMean(window, alpha);
See Also