Files
2026-07-13 13:02:50 +08:00

70 lines
2.8 KiB
C#

/*
* 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.
*/
namespace QuantConnect.Indicators
{
/// <summary>
/// This indicator computes the n-period change in a value using the following:
/// value_0 - value_n
/// </summary>
public class Momentum : WindowIndicator<IndicatorDataPoint>, IIndicatorWarmUpPeriodProvider
{
/// <summary>
/// Required period, in data points, for the indicator to be ready and fully initialized.
/// </summary>
public override int WarmUpPeriod => Period + 1;
/// <summary>
/// Gets a flag indicating when this indicator is ready and fully initialized
/// </summary>
public override bool IsReady => Samples > Period;
/// <summary>
/// Creates a new Momentum indicator with the specified period
/// </summary>
/// <param name="period">The period over which to perform to computation</param>
public Momentum(int period)
: base($"MOM({period})", period)
{
}
/// <summary>
/// Creates a new Momentum indicator with the specified period
/// </summary>
/// <param name="name">The name of this indicator</param>
/// <param name="period">The period over which to perform to computation</param>
public Momentum(string name, int period)
: base(name, period)
{
}
/// <summary>
/// Computes the next value for this indicator from the given state.
/// </summary>
/// <param name="window">The window of data held in this indicator</param>
/// <param name="input">The input value to this indicator on this time step</param>
/// <returns>A new value for this indicator</returns>
protected override decimal ComputeNextValue(IReadOnlyWindow<IndicatorDataPoint> window, IndicatorDataPoint input)
{
if (window.Samples <= window.Size)
{
// keep returning the delta from the first item put in there to init
return input.Value - window[window.Count - 1].Value;
}
return input.Value - window.MostRecentlyRemoved.Value;
}
}
}