Lean  $LEAN_TAG$
IRegressionAlgorithmDefinition.cs
1 /*
2  * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
3  * Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14 */
15 
16 using System.Collections.Generic;
17 
18 namespace QuantConnect.Interfaces
19 {
20  /// <summary>
21  /// Defines a C# algorithm as a regression algorithm to be run as part of the test suite.
22  /// This interface also allows the algorithm to declare that it has versions in other languages
23  /// that should yield identical results.
24  /// </summary>
25  public interface IRegressionAlgorithmDefinition
26  {
27  /// <summary>
28  /// Final status of the algorithm
29  /// </summary>
30  AlgorithmStatus AlgorithmStatus { get; }
31 
32  /// <summary>
33  /// This is used by the regression test system to indicate if the open source Lean repository has the required data to run this algorithm.
34  /// </summary>
35  bool CanRunLocally { get; }
36 
37  /// <summary>
38  /// This is used by the regression test system to indicate which languages this algorithm is written in.
39  /// </summary>
40  List<Language> Languages { get; }
41 
42  /// <summary>
43  /// Data Points count of all timeslices of algorithm
44  /// </summary>
45  long DataPoints { get; }
46 
47  /// <summary>
48  /// Data Points count of the algorithm history
49  /// </summary>
50  int AlgorithmHistoryDataPoints { get; }
51 
52  /// <summary>
53  /// This is used by the regression test system to indicate what the expected statistics are from running the algorithm
54  /// </summary>
55  Dictionary<string, string> ExpectedStatistics { get; }
56  }
57 }