Jhonathan Abreu
5d6110f38c
* Make statistics available at runtime to algorithms * Re-calculate statistics on every call * Housekeeping * Add regression algorithms * Address peer review * Support for custom summary statistics at runtime * Minor changes * Address peer review * Address peer review * Minor changes * Minor changes
40 lines
1.4 KiB
C#
40 lines
1.4 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.
|
|
*
|
|
*/
|
|
|
|
using System.ComponentModel.Composition;
|
|
|
|
namespace QuantConnect.Statistics
|
|
{
|
|
/// <summary>
|
|
/// This interface exposes methods for accessing algorithm statistics results at runtime.
|
|
/// </summary>
|
|
public interface IStatisticsService
|
|
{
|
|
/// <summary>
|
|
/// Calculates and gets the current statistics for the algorithm
|
|
/// </summary>
|
|
/// <returns>The current statistics</returns>
|
|
StatisticsResults StatisticsResults();
|
|
|
|
/// <summary>
|
|
/// Sets or updates a custom summary statistic
|
|
/// </summary>
|
|
/// <param name="name">The statistic name</param>
|
|
/// <param name="value">The statistic value</param>
|
|
void SetSummaryStatistic(string name, string value);
|
|
}
|
|
}
|