/*
* 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 QuantConnect.Data;
using QuantConnect.Interfaces;
using System.Collections.Generic;
using QuantConnect.Orders;
using QuantConnect.Util;
using System;
namespace QuantConnect.Algorithm.CSharp
{
///
/// Simple regression algorithm asserting certain order fields update properly when a
/// split in the data happens
///
public class SplitEquityRegressionAlgorithm: QCAlgorithm, IRegressionAlgorithmDefinition
{
private Symbol _aapl;
private List _tickets = new();
private decimal _marketPriceAtLatestSplit;
private decimal _splitFactor;
public override void Initialize()
{
SetStartDate(2014, 6, 5);
SetEndDate(2014, 6, 11);
SetCash(100000);
_aapl = AddEquity("AAPL", Resolution.Hour, dataNormalizationMode: DataNormalizationMode.Raw).Symbol;
}
public override void OnData(Slice slice)
{
if (slice.Splits.ContainsKey(_aapl))
{
var split = slice.Splits[_aapl];
_splitFactor = split.SplitFactor;
_marketPriceAtLatestSplit = Securities[_aapl].Price;
}
if (Transactions.GetOrders().IsNullOrEmpty())
{
_tickets.Add(LimitIfTouchedOrder(_aapl, 10, 10, 10));
_tickets.Add(LimitOrder(_aapl, 10, 5));
_tickets.Add(StopLimitOrder(_aapl, 10, 15, 15));
_tickets.Add(TrailingStopOrder(_aapl, 10, 1000, 60m, trailingAsPercentage: false));
_tickets.Add(TrailingStopOrder(_aapl, 10, 1000, 0.1m, trailingAsPercentage: true));
}
}
public override void OnEndOfAlgorithm()
{
foreach (var ticket in _tickets)
{
if (ticket.Quantity != 69.0m)
{
throw new RegressionTestException($"The Quantity of order with ID: {ticket.OrderId} should be 69, but was {ticket.Quantity}");
}
switch (ticket.OrderType)
{
case OrderType.LimitIfTouched:
if (ticket.Get(OrderField.TriggerPrice) != 1.43m)
{
throw new RegressionTestException($"Order with ID: {ticket.OrderId} should have a Trigger Price equal to 1.43, but was {ticket.Get(OrderField.TriggerPrice)}");
}
if (ticket.Get(OrderField.LimitPrice) != 1.43m)
{
throw new RegressionTestException($"Order with ID: {ticket.OrderId} should have a Limit Price equal to 1.43, but was {ticket.Get(OrderField.LimitPrice)}");
}
break;
case OrderType.Limit:
if (ticket.Get(OrderField.LimitPrice) != 0.7143m)
{
throw new RegressionTestException($"Order with ID: {ticket.OrderId} should have a Limit Price equal to 0.7143, but was {ticket.Get(OrderField.LimitPrice)}");
}
break;
case OrderType.StopLimit:
if (ticket.Get(OrderField.StopPrice) != 2.14m)
{
throw new RegressionTestException($"Order with ID: {ticket.OrderId} should have a Stop Price equal to 2.14, but was {ticket.Get(OrderField.StopPrice)}");
}
break;
case OrderType.TrailingStop:
var stopPrice = ticket.Get(OrderField.StopPrice);
var trailingAmount = ticket.Get(OrderField.TrailingAmount);
if (ticket.Get(OrderField.TrailingAsPercentage))
{
// We only expect one stop price update in this algorithm
if (Math.Abs(stopPrice - _marketPriceAtLatestSplit) > 0.1m * stopPrice)
{
throw new RegressionTestException($"Order with ID: {ticket.OrderId} should have a Stop Price equal to 2.14, but was {ticket.Get(OrderField.StopPrice)}");
}
// Trailing amount unchanged since it's a percentage
if (trailingAmount != 0.1m)
{
throw new RegressionTestException($"Order with ID: {ticket.OrderId} should have a Trailing Amount equal to 0.214m, but was {trailingAmount}");
}
}
else
{
// We only expect one stop price update in this algorithm
if (Math.Abs(stopPrice - _marketPriceAtLatestSplit) > 60m * _splitFactor)
{
throw new RegressionTestException($"Order with ID: {ticket.OrderId} should have a Stop Price equal to 2.14, but was {ticket.Get(OrderField.StopPrice)}");
}
if (trailingAmount != 8.57m)
{
throw new RegressionTestException($"Order with ID: {ticket.OrderId} should have a Trailing Amount equal to 8.57m, but was {trailingAmount}");
}
}
break;
}
}
}
///
/// This is used by the regression test system to indicate if the open source Lean repository has the required data to run this algorithm.
///
public bool CanRunLocally { get; } = true;
///
/// This is used by the regression test system to indicate which languages this algorithm is written in.
///
public List Languages { get; } = new() { Language.CSharp };
///
/// Data Points count of all timeslices of algorithm
///
public long DataPoints => 80;
///
/// Data Points count of the algorithm history
///
public int AlgorithmHistoryDataPoints => 0;
///
/// Final status of the algorithm
///
public AlgorithmStatus AlgorithmStatus => AlgorithmStatus.Completed;
///
/// This is used by the regression test system to indicate what the expected statistics are from running the algorithm
///
public Dictionary ExpectedStatistics => new Dictionary
{
{"Total Orders", "5"},
{"Average Win", "0%"},
{"Average Loss", "0%"},
{"Compounding Annual Return", "0%"},
{"Drawdown", "0%"},
{"Expectancy", "0"},
{"Start Equity", "100000"},
{"End Equity", "100000"},
{"Net Profit", "0%"},
{"Sharpe Ratio", "0"},
{"Sortino Ratio", "0"},
{"Probabilistic Sharpe Ratio", "0%"},
{"Loss Rate", "0%"},
{"Win Rate", "0%"},
{"Profit-Loss Ratio", "0"},
{"Alpha", "0"},
{"Beta", "0"},
{"Annual Standard Deviation", "0"},
{"Annual Variance", "0"},
{"Information Ratio", "-2.491"},
{"Tracking Error", "0.042"},
{"Treynor Ratio", "0"},
{"Total Fees", "$0.00"},
{"Estimated Strategy Capacity", "$0"},
{"Lowest Capacity Asset", ""},
{"Portfolio Turnover", "0%"},
{"Drawdown Recovery", "0"},
{"OrderListHash", "1433d839e97cd82fc9b051cfd98f166f"}
};
}
}