Aliases
This page lists short names for long type names, and for a few functions.
PortfolioOptimisers.SD — Type
SDAlias for StandardDeviation.
PortfolioOptimisers.UcVariance — Type
UcVarianceAlias for UncertaintySetVariance.
PortfolioOptimisers.WR — Type
WRAlias for WorstRealisation.
PortfolioOptimisers.VaR — Type
VaRAlias for ValueatRisk.
PortfolioOptimisers.CVaR — Type
CVaRAlias for ConditionalValueatRisk.
PortfolioOptimisers.DRCVaR — Type
DRCVaRAlias for DistributionallyRobustConditionalValueatRisk.
PortfolioOptimisers.EVaR — Type
EVaRAlias for EntropicValueatRisk.
PortfolioOptimisers.RLVaR — Type
RLVaRAlias for RelativisticValueatRisk.
PortfolioOptimisers.PNVaR — Type
PNVaRAlias for PowerNormValueatRisk.
PortfolioOptimisers.RG — Type
RGAlias for Range.
PortfolioOptimisers.VaR_RG — Type
VaR_RGAlias for ValueatRiskRange.
PortfolioOptimisers.CVaR_RG — Type
CVaR_RGAlias for ConditionalValueatRiskRange.
PortfolioOptimisers.DRCVaR_RG — Type
DRCVaR_RGAlias for DistributionallyRobustConditionalValueatRiskRange.
PortfolioOptimisers.EVaR_RG — Type
EVaR_RGAlias for EntropicValueatRiskRange.
PortfolioOptimisers.RLVaR_RG — Type
RLVaR_RGAlias for RelativisticValueatRiskRange.
PortfolioOptimisers.PNVaR_RG — Type
PNVaR_RGAlias for PowerNormValueatRiskRange.
PortfolioOptimisers.GVaR_RG — Type
GVaR_RGAlias for GenericValueatRiskRange.
PortfolioOptimisers.DaR — Type
DaRAlias for DrawdownatRisk.
PortfolioOptimisers.CDaR — Type
CDaRAlias for ConditionalDrawdownatRisk.
PortfolioOptimisers.DRCDaR — Type
DRCDaRPortfolioOptimisers.EDaR — Type
EDaRAlias for EntropicDrawdownatRisk.
PortfolioOptimisers.RLDaR — Type
RLDaRAlias for RelativisticDrawdownatRisk.
PortfolioOptimisers.PNDaR — Type
PNDaRAlias for PowerNormDrawdownatRisk.
PortfolioOptimisers.R_DaR — Type
R_DaRAlias for RelativeDrawdownatRisk.
PortfolioOptimisers.R_CDaR — Type
R_CDaRAlias for RelativeConditionalDrawdownatRisk.
PortfolioOptimisers.R_EDaR — Type
R_EDaRAlias for RelativeEntropicDrawdownatRisk.
PortfolioOptimisers.R_RLDaR — Type
R_RLDaRAlias for RelativeRelativisticDrawdownatRisk.
PortfolioOptimisers.R_PNDaR — Type
R_PNDaRAlias for RelativePowerNormDrawdownatRisk.
PortfolioOptimisers.ADD — Type
ADDAlias for AverageDrawdown.
PortfolioOptimisers.R_ADD — Type
R_ADDAlias for RelativeAverageDrawdown.
PortfolioOptimisers.UCI — Type
UCIAlias for UlcerIndex.
PortfolioOptimisers.R_UCI — Type
R_UCIAlias for RelativeUlcerIndex.
PortfolioOptimisers.MDD — Type
MDDAlias for MaximumDrawdown.
PortfolioOptimisers.R_MDD — Type
R_MDDAlias for RelativeMaximumDrawdown.
PortfolioOptimisers.OWA — Type
OWAAlias for OrderedWeightsArray.
PortfolioOptimisers.BDVariance — Type
BDVarianceAlias for BrownianDistanceVariance.
PortfolioOptimisers.TrRM — Type
TrRMAlias for TrackingRiskMeasure.
PortfolioOptimisers.RkTrRM — Type
RkTrRMAlias for RiskTrackingRiskMeasure.
PortfolioOptimisers.TnRM — Type
TnRMAlias for TurnoverRiskMeasure.
PortfolioOptimisers.VSK — Type
VSKAlias for VarianceSkewKurtosis.
PortfolioOptimisers.NonOptRkRatio — Type
NonOptRkRatioAlias for NonOptimisationRiskRatio.
PortfolioOptimisers.RkSet — Type
RkSetAlias for RiskMeasureSettings.
PortfolioOptimisers.HRkSet — Type
HRkSetAlias for HierarchicalRiskMeasureSettings.
PortfolioOptimisers.HRP — Type
HRPAlias for HierarchicalRiskParity.
PortfolioOptimisers.HERC — Type
HERCAlias for HierarchicalEqualRiskContribution.
PortfolioOptimisers.SCHRP — Type
SCHRPAlias for SchurComplementHierarchicalRiskParity.
PortfolioOptimisers.MR — Type
MRAlias for MeanRisk.
PortfolioOptimisers.RB — Type
RBAlias for RiskBudgeting.
PortfolioOptimisers.RRB — Type
RRBAlias for RelaxedRiskBudgeting.
PortfolioOptimisers.FRC — Type
FRCAlias for FactorRiskContribution.
PortfolioOptimisers.NOC — Type
NOCAlias for NearOptimalCentering.
PortfolioOptimisers.NCO — Type
NCOAlias for NestedClustered.
PortfolioOptimisers.STO — Type
STOAlias for Stacking.
PortfolioOptimisers.SSR — Type
SSRAlias for SubsetResampling.
PortfolioOptimisers.JuMPOpt — Type
JuMPOptAlias for JuMPOptimiser.
PortfolioOptimisers.HOpt — Type
HOptAlias for HierarchicalOptimiser.
PortfolioOptimisers.DAO — Type
DAOAlias for DiscreteAllocation.
PortfolioOptimisers.GAO — Type
GAOAlias for GreedyAllocation.
PortfolioOptimisers.FAI — Type
FAIAlias for FiniteAllocationInput.
PortfolioOptimisers.SmER — Type
SmERAlias for SimpleExpectedReturns.
PortfolioOptimisers.GCov — Type
GCovAlias for GeneralCovariance.
PortfolioOptimisers.FMoment — Type
FMomentAlias for FullMoment.
PortfolioOptimisers.SMoment — Type
SMomentAlias for SemiMoment.
PortfolioOptimisers.Cov — Type
CovAlias for Covariance.
PortfolioOptimisers.SVar — Type
SVarAlias for SimpleVariance.
PortfolioOptimisers.G0 — Type
G0Alias for Gerber0.
PortfolioOptimisers.G1 — Type
G1Alias for Gerber1.
PortfolioOptimisers.G2 — Type
G2Alias for Gerber2.
PortfolioOptimisers.GerberCov — Type
GerberCovAlias for GerberCovariance.
PortfolioOptimisers.SBCov — Type
SBCovAlias for SmythBrobyCovariance.
PortfolioOptimisers.SB0 — Type
SB0Alias for SmythBroby0.
PortfolioOptimisers.SB1 — Type
SB1Alias for SmythBroby1.
PortfolioOptimisers.SB2 — Type
SB2Alias for SmythBroby2.
PortfolioOptimisers.SBG0 — Type
SBG0Alias for SmythBrobyGerber0.
PortfolioOptimisers.SBG1 — Type
SBG1Alias for SmythBrobyGerber1.
PortfolioOptimisers.SBG2 — Type
SBG2Alias for SmythBrobyGerber2.
PortfolioOptimisers.SBC0 — Type
SBC0Alias for SmythBrobyCount0.
PortfolioOptimisers.SBC1 — Type
SBC1Alias for SmythBrobyCount1.
PortfolioOptimisers.SBC2 — Type
SBC2Alias for SmythBrobyCount2.
PortfolioOptimisers.DCov — Type
DCovAlias for DistanceCovariance.
PortfolioOptimisers.LTDCov — Type
LTDCovAlias for LowerTailDependenceCovariance.
PortfolioOptimisers.KCov — Type
KCovAlias for KendallCovariance.
PortfolioOptimisers.SCov — Type
SCovAlias for SpearmanCovariance.
PortfolioOptimisers.MICov — Type
MICovAlias for MutualInfoCovariance.
PortfolioOptimisers.POCov — Type
POCovAlias for PortfolioOptimisersCovariance.
PortfolioOptimisers.ShER — Type
ShERAlias for ShrunkExpectedReturns.
PortfolioOptimisers.GM — Type
GMAlias for GrandMean.
PortfolioOptimisers.VW — Type
VWAlias for VolatilityWeighted.
PortfolioOptimisers.MSE — Type
MSEAlias for MeanSquaredError.
PortfolioOptimisers.JS — Type
JSAlias for JamesStein.
PortfolioOptimisers.BS — Type
BSAlias for BayesStein.
PortfolioOptimisers.BOP — Type
BOPAlias for BodnarOkhrinParolya.
PortfolioOptimisers.EqER — Type
EqERAlias for EquilibriumExpectedReturns.
PortfolioOptimisers.ExER — Type
ExERAlias for ExcessExpectedReturns.
PortfolioOptimisers.CoSk — Type
CoSkAlias for Coskewness.
PortfolioOptimisers.CoKt — Type
CoKtAlias for Cokurtosis.
PortfolioOptimisers.LinMod — Type
LinModAlias for LinearModel.
PortfolioOptimisers.GLinMod — Type
GLinModAlias for GeneralisedLinearModel.
PortfolioOptimisers.TTS — Type
TTSAlias for TrainTestSplit.
PortfolioOptimisers.LCE — Type
LCEAlias for LinearConstraintEstimator.
PortfolioOptimisers.ECE — Type
ECEAlias for ExposureConstraintEstimator.
PortfolioOptimisers.WBE — Type
WBEAlias for WeightBoundsEstimator.
PortfolioOptimisers.L2Reg — Type
L2RegAlias for L2Regularisation.
PortfolioOptimisers.LpReg — Type
LpRegAlias for LpRegularisation.
PortfolioOptimisers.MinRk — Type
MinRkAlias for MinimumRisk.
PortfolioOptimisers.MaxRt — Type
MaxRtAlias for MaximumReturn.
PortfolioOptimisers.MaxUt — Type
MaxUtAlias for MaximumUtility.
PortfolioOptimisers.MaxRa — Type
MaxRaAlias for MaximumRatio.
PortfolioOptimisers.FLM — Function
FLM(; settings::RiskMeasureSettings = RiskMeasureSettings(),
w::Option{<:ObsWeights} = nothing,
mu::Option{<:Num_VecNum_VecScalar} = nothing) -> LowOrderMomentAlias for the First Lower Moment (FLM) risk measure, a LowOrderMoment with FirstLowerMoment.
PortfolioOptimisers.MAD — Function
MAD(; settings::RiskMeasureSettings = RiskMeasureSettings(),
w::Option{<:ObsWeights} = nothing,
mu::Option{<:Num_VecNum_VecScalar} = nothing) -> LowOrderMomentAlias for the Mean Absolute Deviation (MAD) risk measure, a LowOrderMoment with MeanAbsoluteDeviation. It does not build MedianAbsoluteDeviation, which is a different risk measure.
PortfolioOptimisers.SCM — Function
SCM(; settings::RiskMeasureSettings = RiskMeasureSettings(),
w::Option{<:ObsWeights} = nothing,
mu::Option{<:Num_VecNum_VecScalar} = nothing,
ve::AbstractVarianceEstimator = SimpleVariance(; me = nothing),
alg::SecondMomentFormulation = SquaredSOCRiskExpr()) -> LowOrderMomentAlias for the Second Central Moment (SCM) risk measure, a LowOrderMoment with SecondMoment and FullMoment. It reports the variance of the portfolio returns over the scenarios, and their standard deviation when alg is SOCRiskExpr.
PortfolioOptimisers.SLM — Function
SLM(; settings::RiskMeasureSettings = RiskMeasureSettings(),
w::Option{<:ObsWeights} = nothing,
mu::Option{<:Num_VecNum_VecScalar} = nothing,
ve::AbstractVarianceEstimator = SimpleVariance(; me = nothing),
alg::SecondMomentFormulation = SquaredSOCRiskExpr()) -> LowOrderMomentAlias for the Second Lower Moment (SLM) risk measure, a LowOrderMoment with SecondMoment and SemiMoment. It reports the semi-variance of the portfolio returns over the scenarios, and their semi-standard deviation when alg is SOCRiskExpr.
PortfolioOptimisers.ECM — Function
ECM(; settings::RiskMeasureSettings = RiskMeasureSettings(),
w::Option{<:ObsWeights} = nothing,
mu::Option{<:Num_VecNum_VecScalar} = nothing, p::Integer = 2,
ddof::Integer = 0) -> LowOrderMomentAlias for the p-th root of the central even moment of order 2p, a LowOrderMoment with EvenMoment and FullMoment.
PortfolioOptimisers.ELM — Function
ELM(; settings::RiskMeasureSettings = RiskMeasureSettings(),
w::Option{<:ObsWeights} = nothing,
mu::Option{<:Num_VecNum_VecScalar} = nothing, p::Integer = 2,
ddof::Integer = 0) -> LowOrderMomentAlias for the p-th root of the lower even moment of order 2p, a LowOrderMoment with EvenMoment and SemiMoment.
PortfolioOptimisers.TLM — Function
TLM(; settings::RiskMeasureSettings = RiskMeasureSettings(),
w::Option{<:ObsWeights} = nothing,
mu::Option{<:Num_VecNum_VecScalar} = nothing) -> HighOrderMomentAlias for the Third Lower Moment (TLM) risk measure, a HighOrderMoment with ThirdLowerMoment.
PortfolioOptimisers.SSK — Function
SSK(; settings::RiskMeasureSettings = RiskMeasureSettings(),
w::Option{<:ObsWeights} = nothing,
mu::Option{<:Num_VecNum_VecScalar} = nothing,
ve::AbstractVarianceEstimator = SimpleVariance(; me = nothing)) -> HighOrderMomentAlias for the Standardised Third Lower Moment (SSK) risk measure, a HighOrderMoment with ThirdLowerMoment and a variance estimator in ve. It is the semi-skewness of the portfolio returns over the scenarios.
PortfolioOptimisers.FTCM — Function
FTCM(; settings::RiskMeasureSettings = RiskMeasureSettings(),
w::Option{<:ObsWeights} = nothing,
mu::Option{<:Num_VecNum_VecScalar} = nothing) -> HighOrderMomentAlias for the Fourth Central Moment (FTCM) risk measure, a HighOrderMoment with FourthMoment and FullMoment.
PortfolioOptimisers.FTLM — Function
FTLM(; settings::RiskMeasureSettings = RiskMeasureSettings(),
w::Option{<:ObsWeights} = nothing,
mu::Option{<:Num_VecNum_VecScalar} = nothing) -> HighOrderMomentAlias for the Fourth Lower Moment (FTLM) risk measure, a HighOrderMoment with FourthMoment and SemiMoment.
PortfolioOptimisers.KT — Function
KT(; settings::RiskMeasureSettings = RiskMeasureSettings(),
w::Option{<:ObsWeights} = nothing,
mu::Option{<:Num_VecNum_VecScalar} = nothing,
ve::AbstractVarianceEstimator = SimpleVariance(; me = nothing)) -> HighOrderMomentAlias for the Standardised Fourth Central Moment (KT) risk measure, a HighOrderMoment with FourthMoment, FullMoment and a variance estimator in ve. It is the kurtosis of the portfolio returns over the scenarios.
PortfolioOptimisers.SKT — Function
SKT(; settings::RiskMeasureSettings = RiskMeasureSettings(),
w::Option{<:ObsWeights} = nothing,
mu::Option{<:Num_VecNum_VecScalar} = nothing,
ve::AbstractVarianceEstimator = SimpleVariance(; me = nothing)) -> HighOrderMomentAlias for the Standardised Fourth Lower Moment (SKT) risk measure, a HighOrderMoment with FourthMoment, SemiMoment and a variance estimator in ve. It is the semi-kurtosis of the portfolio returns over the scenarios.
PortfolioOptimisers.OWA_GMD — Function
OWA_GMD(; settings::RiskMeasureSettings = RiskMeasureSettings(),
alg::OrderedWeightsArrayFormulation = ApproxOrderedWeightsArray()) -> OrderedWeightsArrayAlias for the Gini Mean Difference (GMD) OrderedWeightsArray risk measure with owa_gmd weights.
PortfolioOptimisers.OWA_CVaR — Function
OWA_CVaR(; settings::RiskMeasureSettings = RiskMeasureSettings(),
alpha::Number = 0.05,
alg::OrderedWeightsArrayFormulation = ApproxOrderedWeightsArray()) -> OrderedWeightsArrayAlias for the Conditional Value at Risk (CVaR) OrderedWeightsArray risk measure with OrderedWeightsArrayConditionalValueatRisk weights at significance level alpha.
PortfolioOptimisers.OWA_TG — Function
OWA_TG(; settings::RiskMeasureSettings = RiskMeasureSettings(),
alpha_i::Number = 1e-4,
alpha::Number = 0.05,
a_sim::Integer = 100,
alg::OrderedWeightsArrayFormulation = ApproxOrderedWeightsArray()) -> OrderedWeightsArrayAlias for the Tail Gini (TG) OrderedWeightsArray risk measure with OrderedWeightsArrayTailGini weights.
PortfolioOptimisers.OWA_WR — Function
OWA_WR(; settings::RiskMeasureSettings = RiskMeasureSettings(),
alg::OrderedWeightsArrayFormulation = ApproxOrderedWeightsArray()) -> OrderedWeightsArrayAlias for the Worst Realisation (WR) OrderedWeightsArray risk measure with owa_wr weights.
PortfolioOptimisers.OWA_RG — Function
OWA_RG(; settings::RiskMeasureSettings = RiskMeasureSettings(),
alg::OrderedWeightsArrayFormulation = ApproxOrderedWeightsArray()) -> OrderedWeightsArrayRangeAlias for the Range (RG) OrderedWeightsArrayRange risk measure, with owa_wr weights in the loss tail and their reversal in the gain tail. Its value is that of owa_rg.
PortfolioOptimisers.OWA_CVaR_RG — Function
OWA_CVaR_RG(; settings::RiskMeasureSettings = RiskMeasureSettings(),
alpha::Number = 0.05,
beta::Number = alpha,
alg::OrderedWeightsArrayFormulation = ApproxOrderedWeightsArray()) -> OrderedWeightsArrayRangeAlias for the Conditional Value at Risk Range (CVaR RG) OrderedWeightsArrayRange risk measure, with OrderedWeightsArrayConditionalValueatRisk weights at alpha in the loss tail and the reversed weights at beta in the gain tail. Its value is that of owa_cvarrg.
PortfolioOptimisers.OWA_TG_RG — Function
OWA_TG_RG(; settings::RiskMeasureSettings = RiskMeasureSettings(),
alpha_i::Number = 1e-4,
alpha::Number = 0.05,
a_sim::Integer = 100,
beta_i::Number = alpha_i,
beta::Number = alpha,
b_sim::Integer = a_sim,
alg::OrderedWeightsArrayFormulation = ApproxOrderedWeightsArray()) -> OrderedWeightsArrayRangeAlias for the Tail Gini Range (TG RG) OrderedWeightsArrayRange risk measure, with OrderedWeightsArrayTailGini weights at alpha_i, alpha and a_sim in the loss tail and the reversed weights at beta_i, beta and b_sim in the gain tail. Its value is that of owa_tgrg.
PortfolioOptimisers.OWA_LMoment — Function
OWA_LMoment(; settings::RiskMeasureSettings = RiskMeasureSettings(),
method::AbstractOrderedWeightsArrayEstimator = NormalisedConstantRelativeRiskAversion(),
k::Integer = 2,
alg::OrderedWeightsArrayFormulation = ApproxOrderedWeightsArray()) -> OrderedWeightsArrayAlias for the L-Moment OrderedWeightsArray risk measure with LinearMoment weights of order k.
PortfolioOptimisers.DnCov — Function
DnCovAlias for DenoiseCovariance.
PortfolioOptimisers.DtCov — Function
DtCovAlias for DetoneCovariance.
PortfolioOptimisers.PrCov — Function
PrCovAlias for ProcessedCovariance.
PortfolioOptimisers.ZeroVarianceFilter — Function
ZeroVarianceFilter(; tol::Number = 1e-12) -> ScoreSelectorAlias for the zero-variance asset selector, a ScoreSelector that scores with SCM and selects with a ThresholdRule.
It keeps the assets whose second central moment strictly exceeds tol, so it drops constant and near-constant columns before they reach a prior or an optimiser. The bound is exclusive, so tol = 0 still drops an exactly-constant asset.
It scores with SCM() and not with Variance. Variance is a WeightsInput risk measure whose functor takes portfolio weights, so it cannot score the return series of one asset.
Validation
tol >= 0.