/*
* QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
* Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using System;
namespace QuantConnect.Indicators
{
///
/// This indicator computes the n-period adaptive weighted moving average indicator.
/// VIDYAi = Pricei x F x ABS(CMOi) + VIDYAi-1 x (1 - F x ABS(CMOi))
/// where:
/// VIDYAi - is the value of the current period.
/// Pricei - is the source price of the period being calculated.
/// F = 2/(Period_EMA+1) - is a smoothing factor.
/// ABS(CMOi) - is the absolute current value of CMO.
/// VIDYAi-1 - is the value of the period immediately preceding the period being calculated.
///
public class VariableIndexDynamicAverage : WindowIndicator, IIndicatorWarmUpPeriodProvider
{
private decimal _vidya;
private ChandeMomentumOscillator _CMO;
private readonly decimal _smoothingFactor;
///
/// Initializes a new instance of the class using the specified period.
///
/// The period of the indicator
public VariableIndexDynamicAverage(int period)
: this($"VIDYA({period})", period)
{
}
///
/// Initializes a new instance of the class using the specified name and period.
///
/// The name of this indicator
/// The period of the indicator
public VariableIndexDynamicAverage(string name, int period)
: base(name, period)
{
_CMO = new ChandeMomentumOscillator(period);
_smoothingFactor = 2m / (period + 1);
}
///
/// Gets a flag indicating when this indicator is ready and fully initialized
///
public override bool IsReady => Samples > Period;
///
/// Required period, in data points, for the indicator to be ready and fully initialized.
///
public override int WarmUpPeriod => Period + 1;
///
/// Computes the next value of this indicator from the given state
///
/// The input given to the indicator
/// The window for the input history
/// A new value for this indicator
protected override decimal ComputeNextValue(IReadOnlyWindow window, IndicatorDataPoint input)
{
_CMO.Update(input);
if (!IsReady)
{
_vidya = input.Value;
return 0m;
}
var absCMO = Math.Abs(_CMO.Current.Value / 100);
_vidya = (input.Value * _smoothingFactor * absCMO) + (_vidya * (1 - _smoothingFactor * absCMO));
return _vidya;
}
///
/// Resets this indicator to its initial state
///
public override void Reset()
{
_vidya = 0;
_CMO.Reset();
base.Reset();
}
}
}