Provides an implementation of IPortfolioConstructionModel that gives equal weighting to all securities. The target percent holdings of each security is 1/N where N is the number of securities. For insights of direction InsightDirection.Up, long targets are returned and for insights of direction InsightDirection.Down, short targets are returned. More...
Protected Member Functions | |
| override Dictionary< Insight, double > | DetermineTargetPercent (List< Insight > activeInsights) |
| Will determine the target percent for each insight More... | |
| bool | RespectPortfolioBias (Insight insight) |
| Method that will determine if a given insight respects the portfolio bias More... | |
 Protected Member Functions inherited from QuantConnect.Algorithm.Framework.Portfolio.PortfolioConstructionModel | |
| void | SetPythonWrapper (PortfolioConstructionModelPythonWrapper pythonWrapper) |
| Used to set the PortfolioConstructionModelPythonWrapper instance if any More... | |
| virtual List< Insight > | GetTargetInsights () |
| Gets the target insights to calculate a portfolio target percent for More... | |
| virtual bool | ShouldCreateTargetForInsight (Insight insight) |
| Method that will determine if the portfolio construction model should create a target for this insight More... | |
| void | SetRebalancingFunc (PyObject rebalance) |
| Python helper method to set the rebalancing function. This is required due to a python net limitation not being able to use the base type constructor, and also because when python algorithms use C# portfolio construction models, it can't convert python methods into func nor resolve the correct constructor for the date rules, timespan parameter. For performance we prefer python algorithms using the C# implementation More... | |
| virtual bool | IsRebalanceDue (Insight[] insights, DateTime algorithmUtc) |
| Determines if the portfolio should be rebalanced base on the provided rebalancing func, if any security change have been taken place or if an insight has expired or a new insight arrived If the rebalancing function has not been provided will return true. More... | |
| void | RefreshRebalance (DateTime algorithmUtc) |
| Refresh the next rebalance time and clears the security changes flag More... | |
Additional Inherited Members | |
| Static Protected Member Functions inherited from QuantConnect.Algorithm.Framework.Portfolio.PortfolioConstructionModel | |
| static Insight[] | FilterInvalidInsightMagnitude (IAlgorithm algorithm, Insight[] insights) |
| Helper class that can be used by the different IPortfolioConstructionModel implementations to filter Insight instances with an invalid Insight.Magnitude value based on the IAlgorithmSettings More... | |
| Protected Attributes inherited from QuantConnect.Algorithm.Framework.Portfolio.PortfolioConstructionModel | |
| PortfolioConstructionModelPythonWrapper | PythonWrapper |
| This is required due to a limitation in PythonNet to resolved overriden methods. When Python calls a C# method that calls a method that's overriden in python it won't run the python implementation unless the call is performed through python too. More... | |
| Properties inherited from QuantConnect.Algorithm.Framework.Portfolio.PortfolioConstructionModel | |
| virtual bool | RebalanceOnSecurityChanges = true [get, set] |
| True if should rebalance portfolio on security changes. True by default More... | |
| virtual bool | RebalanceOnInsightChanges = true [get, set] |
| True if should rebalance portfolio on new insights or expiration of insights. True by default More... | |
| IAlgorithm | Algorithm [get] |
| The algorithm instance More... | |
Detailed Description
Provides an implementation of IPortfolioConstructionModel that gives equal weighting to all securities. The target percent holdings of each security is 1/N where N is the number of securities. For insights of direction InsightDirection.Up, long targets are returned and for insights of direction InsightDirection.Down, short targets are returned.
Definition at line 31 of file EqualWeightingPortfolioConstructionModel.cs.
Constructor & Destructor Documentation
◆ EqualWeightingPortfolioConstructionModel() [1/6]
| QuantConnect.Algorithm.Framework.Portfolio.EqualWeightingPortfolioConstructionModel.EqualWeightingPortfolioConstructionModel | ( | IDateRule | rebalancingDateRules, |
| PortfolioBias | portfolioBias = PortfolioBias.LongShort |
||
| ) |
Initialize a new instance of EqualWeightingPortfolioConstructionModel
- Parameters
-
rebalancingDateRules The date rules used to define the next expected rebalance time in UTC portfolioBias Specifies the bias of the portfolio (Short, Long/Short, Long)
Definition at line 41 of file EqualWeightingPortfolioConstructionModel.cs.
◆ EqualWeightingPortfolioConstructionModel() [2/6]
| QuantConnect.Algorithm.Framework.Portfolio.EqualWeightingPortfolioConstructionModel.EqualWeightingPortfolioConstructionModel | ( | Func< DateTime, DateTime?> | rebalancingFunc, |
| PortfolioBias | portfolioBias = PortfolioBias.LongShort |
||
| ) |
Initialize a new instance of EqualWeightingPortfolioConstructionModel
- Parameters
-
rebalancingFunc For a given algorithm UTC DateTime returns the next expected rebalance time or null if unknown, in which case the function will be called again in the next loop. Returning current time will trigger rebalance. If null will be ignored portfolioBias Specifies the bias of the portfolio (Short, Long/Short, Long)
Definition at line 54 of file EqualWeightingPortfolioConstructionModel.cs.
◆ EqualWeightingPortfolioConstructionModel() [3/6]
| QuantConnect.Algorithm.Framework.Portfolio.EqualWeightingPortfolioConstructionModel.EqualWeightingPortfolioConstructionModel | ( | Func< DateTime, DateTime > | rebalancingFunc, |
| PortfolioBias | portfolioBias = PortfolioBias.LongShort |
||
| ) |
Initialize a new instance of EqualWeightingPortfolioConstructionModel
- Parameters
-
rebalancingFunc For a given algorithm UTC DateTime returns the next expected rebalance UTC time. Returning current time will trigger rebalance. If null will be ignored portfolioBias Specifies the bias of the portfolio (Short, Long/Short, Long)
Definition at line 67 of file EqualWeightingPortfolioConstructionModel.cs.
◆ EqualWeightingPortfolioConstructionModel() [4/6]
| QuantConnect.Algorithm.Framework.Portfolio.EqualWeightingPortfolioConstructionModel.EqualWeightingPortfolioConstructionModel | ( | PyObject | rebalance, |
| PortfolioBias | portfolioBias = PortfolioBias.LongShort |
||
| ) |
Initialize a new instance of EqualWeightingPortfolioConstructionModel
- Parameters
-
rebalance Rebalancing func or if a date rule, timedelta will be converted into func. For a given algorithm UTC DateTime the func returns the next expected rebalance time or null if unknown, in which case the function will be called again in the next loop. Returning current time will trigger rebalance. If null will be ignored portfolioBias Specifies the bias of the portfolio (Short, Long/Short, Long)
This is required since python net can not convert python methods into func nor resolve the correct constructor for the date rules parameter. For performance we prefer python algorithms using the C# implementation
Definition at line 84 of file EqualWeightingPortfolioConstructionModel.cs.
◆ EqualWeightingPortfolioConstructionModel() [5/6]
| QuantConnect.Algorithm.Framework.Portfolio.EqualWeightingPortfolioConstructionModel.EqualWeightingPortfolioConstructionModel | ( | TimeSpan | timeSpan, |
| PortfolioBias | portfolioBias = PortfolioBias.LongShort |
||
| ) |
Initialize a new instance of EqualWeightingPortfolioConstructionModel
- Parameters
-
timeSpan Rebalancing frequency portfolioBias Specifies the bias of the portfolio (Short, Long/Short, Long)
Definition at line 96 of file EqualWeightingPortfolioConstructionModel.cs.
◆ EqualWeightingPortfolioConstructionModel() [6/6]
| QuantConnect.Algorithm.Framework.Portfolio.EqualWeightingPortfolioConstructionModel.EqualWeightingPortfolioConstructionModel | ( | Resolution | resolution = Resolution.Daily, |
| PortfolioBias | portfolioBias = PortfolioBias.LongShort |
||
| ) |
Initialize a new instance of EqualWeightingPortfolioConstructionModel
- Parameters
-
resolution Rebalancing frequency portfolioBias Specifies the bias of the portfolio (Short, Long/Short, Long)
Definition at line 107 of file EqualWeightingPortfolioConstructionModel.cs.
Member Function Documentation
◆ DetermineTargetPercent()
|
protectedvirtual |
Will determine the target percent for each insight
- Parameters
-
activeInsights The active insights to generate a target for
- Returns
- A target percent for each insight
Reimplemented from QuantConnect.Algorithm.Framework.Portfolio.PortfolioConstructionModel.
Reimplemented in QuantConnect.Algorithm.Framework.Portfolio.InsightWeightingPortfolioConstructionModel, and QuantConnect.Algorithm.Framework.Portfolio.SectorWeightingPortfolioConstructionModel.
Definition at line 118 of file EqualWeightingPortfolioConstructionModel.cs.
◆ RespectPortfolioBias()
|
protected |
Method that will determine if a given insight respects the portfolio bias
- Parameters
-
insight The insight to create a target for
- Returns
- True if the insight respects the portfolio bias
Definition at line 139 of file EqualWeightingPortfolioConstructionModel.cs.
The documentation for this class was generated from the following file:
- Algorithm.Framework/Portfolio/EqualWeightingPortfolioConstructionModel.cs
