Skip to content

LinearRegressionForecast

Summary

Linear Regression Forecast is one of the indicators calculated by the Linear Regression approach.

Remarks

The Linear Regression Forecast is used for identifying trends and trend direction, and shows the statistical trend of a financial instrument over a specified time period. The calculation uses a Linear Regression Line.

Signature 

1
public abstract interface LinearRegressionForecast

Namespace

cAlgo.API.Indicators

Examples

1
2
3
4
5
6
7
8
 private LinearRegressionForecast _linearRegressionForecast;
 [Parameter("Period", DefaultValue = 14)]
 public int Period { get; set; }
 protected override void Initialize()
 {
     // initialize a new instance of LinearRegressionForecastIndicator class
     _linearRegressionForecast = Indicators.LinearRegressionForecast(Bars.ClosePrices, Period);
 }

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 using cAlgo.API;
 using cAlgo.API.Indicators;
 using cAlgo.API.Internals;
 namespace cAlgo.Robots
 {
     // This sample cBot shows how to use the Linear Regression Forecast indicator
     [Robot(TimeZone = TimeZones.UTC, AccessRights = AccessRights.None)]
     public class LinearRegressionForecastSample : Robot
     {
         private double _volumeInUnits;
         private LinearRegressionForecast _linearRegressionForecast;
         [Parameter("Volume (Lots)", DefaultValue = 0.01)]
         public double VolumeInLots { get; set; }
         [Parameter("Stop Loss (Pips)", DefaultValue = 10)]
         public double StopLossInPips { get; set; }
         [Parameter("Take Profit (Pips)", DefaultValue = 10)]
         public double TakeProfitInPips { get; set; }
         [Parameter("Label", DefaultValue = "Sample")]
         public string Label { get; set; }
         public Position[] BotPositions
         {
             get
             {
                 return Positions.FindAll(Label);
             }
         }
         protected override void OnStart()
         {
             _volumeInUnits = Symbol.QuantityToVolumeInUnits(VolumeInLots);
             _linearRegressionForecast = Indicators.LinearRegressionForecast(Bars.ClosePrices, 20);
         }
         protected override void OnBar()
         {
             if (Bars.ClosePrices.Last(1) > _linearRegressionForecast.Result.Last(1) && Bars.ClosePrices.Last(2) <= _linearRegressionForecast.Result.Last(2))
             {
                 ClosePositions(TradeType.Sell);
                 ExecuteMarketOrder(TradeType.Buy, SymbolName, _volumeInUnits, Label, StopLossInPips, TakeProfitInPips);
             }
             else if (Bars.ClosePrices.Last(1) < _linearRegressionForecast.Result.Last(1) && Bars.ClosePrices.Last(2) >= _linearRegressionForecast.Result.Last(2))
             {
                 ClosePositions(TradeType.Buy);
                 ExecuteMarketOrder(TradeType.Sell, SymbolName, _volumeInUnits, Label, StopLossInPips, TakeProfitInPips);
             }
         }
         private void ClosePositions(TradeType tradeType)
         {
             foreach (var position in BotPositions)
             {
                 if (position.TradeType != tradeType) continue;
                 ClosePosition(position);
             }
         }
     }
 }

1
2
3
4
5
6
7
 import clr
 clr.AddReference("cAlgo.API")
 from cAlgo.API import *
 class Test():    
     def initialize(self):
         # Period is a parameter defined in C# file of indicator
         self.linearRegressionForecast = api.Indicators.LinearRegressionForecast(Bars.ClosePrices, api.Period)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 import clr
 clr.AddReference("cAlgo.API")
 # Import cAlgo API types
 from cAlgo.API import *
 # Import trading wrapper functions
 from robot_wrapper import *
 class LinearRegressionForecastSample():
     def on_start(self):
         self.volumeInUnits = api.Symbol.QuantityToVolumeInUnits(api.VolumeInLots)
         self.linearRegressionForecast = api.Indicators.LinearRegressionForecast(api.Source, api.Periods)
     def on_bar_closed(self):
         if api.Bars.ClosePrices.Last(0) > self.linearRegressionForecast.Result.Last(0) and api.Bars.ClosePrices.Last(1) <= self.linearRegressionForecast.Result.Last(1):
             self.close_positions(TradeType.Sell)
             api.ExecuteMarketOrder(TradeType.Buy, api.SymbolName, self.volumeInUnits, api.Label, api.StopLossInPips, api.TakeProfitInPips)
         elif api.Bars.ClosePrices.Last(0) < self.linearRegressionForecast.Result.Last(0) and api.Bars.ClosePrices.Last(1) >= self.linearRegressionForecast.Result.Last(1):
             self.close_positions(TradeType.Buy)
             api.ExecuteMarketOrder(TradeType.Sell, api.SymbolName, self.volumeInUnits, api.Label, api.StopLossInPips, api.TakeProfitInPips)
     def get_bot_positions(self):
         return api.Positions.FindAll(api.Label)
     def close_positions(self, tradeType):
         for position in self.get_bot_positions():
             if position.TradeType != tradeType:
                 continue
             api.ClosePosition(position)

Properties

Result

Summary

The Result Series of the Linear Regression Forecast Indicator

Signature 

1
public abstract IndicatorDataSeries Result {get;}

Return Value

IndicatorDataSeries

Examples

1
2
3
4
5
 public override void Calculate(int index)
 {
     // Print the current result of the Linear Regression Forecast to the log
     Print("Linear Regression Forecast at the current index is = {0}", _linearRegressionForecast.Result[index]);
 }

1
2
3
 def calculate(self, index):
     # Print the current result of the Linear Regression Forecast to the log
     print(f"Linear Regression Forecast at the current index is = {self.linearRegressionForecast.Result[index]}")